gnu.java.awt.peer.gtk

Class GtkImage


public class GtkImage
extends Image

GtkImage - wraps a GdkPixbuf. A GdkPixbuf is 'on-screen' and the gdk cannot draw to it, this is used for the other constructors (and other createImage methods), and corresponds to the Image implementations returned by the Toolkit.createImage methods, and is basically immutable.

Field Summary

Fields inherited from class java.awt.Image

SCALE_AREA_AVERAGING, SCALE_DEFAULT, SCALE_FAST, SCALE_REPLICATE, SCALE_SMOOTH, UndefinedProperty, accelerationPriority

Constructor Summary

GtkImage()
Constructs a blank GtkImage.
GtkImage(byte[] data)
Constructs a GtkImage from a byte array of an image file.
GtkImage(ImageProducer producer)
Constructs a GtkImage from an ImageProducer.
GtkImage(String filename)
Constructs a GtkImage by loading a given file.
GtkImage(URL url)
Constructs a GtkImage from a URL.

Method Summary

int
checkImage(ImageObserver observer)
Returns the image status, used by GtkToolkit
void
finalize()
Called on an object by the Virtual Machine at most once, at some point after the Object is determined unreachable but before it is destroyed.
void
flush()
If the image is loaded and comes from an ImageProducer, regenerate the image from there.
Graphics
getGraphics()
Does nothing.
int
getHeight(ImageObserver observer)
Object
getProperty(String name, ImageObserver observer)
Image
getScaledInstance(int width, int height, int hints)
Returns a scaled instance of this pixbuf.
ImageProducer
getSource()
Returns the source of this image.
int
getWidth(ImageObserver observer)
void
setImage(int width, int height, int[] pixels, Hashtable properties)
Callback from the image consumer.

Methods inherited from class java.awt.Image

flush, getAccelerationPriority, getGraphics, getHeight, getProperty, getScaledInstance, getSource, getWidth, setAccelerationPriority

Methods inherited from class java.lang.Object

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

Constructor Details

GtkImage

public GtkImage()
Constructs a blank GtkImage. This is called when GtkToolkit.createImage (String) is called with an empty string argument (""). A blank image is loaded immediately upon construction and has width -1 and height -1.

GtkImage

public GtkImage(byte[] data)
Constructs a GtkImage from a byte array of an image file.
Throws:
IllegalArgumentException - if the image could not be loaded.

GtkImage

public GtkImage(ImageProducer producer)
Constructs a GtkImage from an ImageProducer. Asynchronity is handled in the following manner: A GtkImageConsumer gets the image data, and calls setImage() when completely finished. The GtkImage is not considered loaded until the GtkImageConsumer is completely finished. We go for all "all or nothing".

GtkImage

public GtkImage(String filename)
Constructs a GtkImage by loading a given file.
Throws:
IllegalArgumentException - if the image could not be loaded.

GtkImage

public GtkImage(URL url)
Constructs a GtkImage from a URL. May result in an error image.

Method Details

checkImage

public int checkImage(ImageObserver observer)
Returns the image status, used by GtkToolkit

finalize

public void finalize()
Called on an object by the Virtual Machine at most once, at some point after the Object is determined unreachable but before it is destroyed. You would think that this means it eventually is called on every Object, but this is not necessarily the case. If execution terminates abnormally, garbage collection does not always happen. Thus you cannot rely on this method to always work. For finer control over garbage collection, use references from the java.lang.ref package.

Virtual Machines are free to not call this method if they can determine that it does nothing important; for example, if your class extends Object and overrides finalize to do simply super.finalize().

finalize() will be called by a Thread that has no locks on any Objects, and may be called concurrently. There are no guarantees on the order in which multiple objects are finalized. This means that finalize() is usually unsuited for performing actions that must be thread-safe, and that your implementation must be use defensive programming if it is to always work.

If an Exception is thrown from finalize() during garbage collection, it will be patently ignored and the Object will still be destroyed.

It is allowed, although not typical, for user code to call finalize() directly. User invocation does not affect whether automatic invocation will occur. It is also permitted, although not recommended, for a finalize() method to "revive" an object by making it reachable from normal code again.

Unlike constructors, finalize() does not get called for an object's superclass unless the implementation specifically calls super.finalize().

The default implementation does nothing.

Overrides:
finalize in interface Object

flush

public void flush()
If the image is loaded and comes from an ImageProducer, regenerate the image from there. I have no idea if this is ever actually used. Since GtkImage can't be instantiated directly, how is the user to know if it was created from an ImageProducer or not?
Overrides:
flush in interface Image

getGraphics

public Graphics getGraphics()
Does nothing. Should not be called.
Overrides:
getGraphics in interface Image

getHeight

public int getHeight(ImageObserver observer)
Overrides:
getHeight in interface Image

getProperty

public Object getProperty(String name,
                          ImageObserver observer)
Overrides:
getProperty in interface Image

getScaledInstance

public Image getScaledInstance(int width,
                               int height,
                               int hints)
Returns a scaled instance of this pixbuf.
Overrides:
getScaledInstance in interface Image

getSource

public ImageProducer getSource()
Returns the source of this image.
Overrides:
getSource in interface Image

getWidth

public int getWidth(ImageObserver observer)
Overrides:
getWidth in interface Image

setImage

public void setImage(int width,
                     int height,
                     int[] pixels,
                     Hashtable properties)
Callback from the image consumer.

GtkImage.java Copyright (C) 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.