org.gnu.gtk

Class Image

public class Image extends Misc

The Image widget displays an image. Various kinds of objects can be displayed as an image; most typically you would create a {@link org.gnu.gdk.Pixbuf} from a file and then display that.

If the file isn't loaded successfully, the image will contain a "broken image" icon similar to that used in many web browsers.

Constructor Summary
Image(String filename)
Construct a new image passing the filename of an image.
Image(Image image, Bitmap mask)
Create an Image widget displaying a image and a mask.
Image(Pixbuf pixbuf)
Creates an Image from a {@link org.gnu.gdk.Pixbuf}.
Image(Pixmap pixmap, Bitmap mask)
Create an Image from a {@link org.gnu.gdk.Pixmap}.
Image(PixbufAnimation animation)
Creates an Image displaying the given PixbufAnimation.
Image(String iconName, IconSize size)
Create an Image
Image(Handle handle)
Construct an Image from a handle to a native resource.
Image(IconSet iconSet, IconSize size)
Creates an Image displaying an IconSet.
Image(GtkStockItem stockId, IconSize size)
Create an Image displaying a Stock icon.
Image()
Constructs a new Image.
Method Summary
StringgetIconName()
static ImagegetImage(Handle handle)
Construct an Image from a handle to a native resource.
ImagegetImage()
Gets the {@link org.gnu.gdk.Image} being displayed by this.
BitmapgetImageMask()
Gets the {@link Bitmap} being used as a map by the Image The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_IMAGE.
PixbufgetPixbuf()
Gets the {@link Pixbuf} being displayed by the Image.
intgetPixelSize()
ImageTypegetStorageType()
Gets the type of representation being used by the Image to store image data.
static TypegetType()
Retrieve the runtime type used by the GLib library.
voidset(Pixmap pixmap, Bitmap mask)
Sets the image to the given {@link org.gnu.gdk.Pixmap}.
voidset(Image image, Bitmap mask)
Sets the image widget to displaying a image and a mask.
voidset(Pixbuf pixbuf)
Sets the Image from a {@link org.gnu.gdk.Pixbuf}.
voidset(PixbufAnimation animation)
Sets to image to the given PixbufAnimation.
voidset(String iconName, IconSize size)
voidset(IconSet iconSet, IconSize size)
Sets the image to displayian IconSet.
voidset(GtkStockItem stockId, IconSize size)
Set the image to a Stock icon.
voidset(String filename)
Sets the image from a file
voidsetPixelSize(int pixelSize)

Constructor Detail

Image

public Image(String filename)
Construct a new image passing the filename of an image.

Parameters: filename The filename for the image to load.

Image

public Image(Image image, Bitmap mask)
Create an Image widget displaying a image and a mask. A org.gnu.gdk.Image is a client-side image buffer in the pixel format of the current display.

Parameters: image The org.gnu.gdk.Image to use for this object creation. mask The org.gnu.gdk.Mask to apply to the image.

Image

public Image(Pixbuf pixbuf)
Creates an Image from a {@link org.gnu.gdk.Pixbuf}.

Parameters: pixbuf The Pixbuf to use for the Image creation.

Image

public Image(Pixmap pixmap, Bitmap mask)
Create an Image from a {@link org.gnu.gdk.Pixmap}.

Parameters: pixmap The Pixmap to use for the Image creation. mask The mask to apply to the created Image.

Image

public Image(PixbufAnimation animation)
Creates an Image displaying the given PixbufAnimation.

Parameters: animation The PixbufAnimation to use for this object creation.

Image

public Image(String iconName, IconSize size)
Create an Image

Image

public Image(Handle handle)
Construct an Image from a handle to a native resource.

Image

public Image(IconSet iconSet, IconSize size)
Creates an Image displaying an IconSet.

Parameters: iconSet The IconSet to use for the Image. size The IconSize to use for the Image.

Image

public Image(GtkStockItem stockId, IconSize size)
Create an Image displaying a Stock icon.

Parameters: stockId The id of the Stock icon to display. size The size of the icon.

Image

public Image()
Constructs a new Image. This will be displayed as a "no image" icon until an image is set using one of the set* methods.

Method Detail

getIconName

public String getIconName()

getImage

public static Image getImage(Handle handle)
Construct an Image from a handle to a native resource.

getImage

public Image getImage()
Gets the {@link org.gnu.gdk.Image} being displayed by this. The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_IMAGE.

Returns: The image being displayed by the image

See Also: getStorageType

getImageMask

public Bitmap getImageMask()
Gets the {@link Bitmap} being used as a map by the Image The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_IMAGE.

Returns: The map being used by the image

See Also: getStorageType

getPixbuf

public Pixbuf getPixbuf()
Gets the {@link Pixbuf} being displayed by the Image. The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_PIXBUF.

Returns: The pixbuf being used by the image.

See Also: getStorageType

getPixelSize

public int getPixelSize()

getStorageType

public ImageType getStorageType()
Gets the type of representation being used by the Image to store image data.

getType

public static Type getType()
Retrieve the runtime type used by the GLib library.

set

public void set(Pixmap pixmap, Bitmap mask)
Sets the image to the given {@link org.gnu.gdk.Pixmap}.

Parameters: pixmap The Pixmap to use for the Image. mask The mask to apply to the Image.

set

public void set(Image image, Bitmap mask)
Sets the image widget to displaying a image and a mask. A org.gnu.gdk.Image is a client-side image buffer in the pixel format of the current display.

Parameters: image The org.gnu.gdk.Image to use for this object. mask The org.gnu.gdk.Mask to apply to the image.

set

public void set(Pixbuf pixbuf)
Sets the Image from a {@link org.gnu.gdk.Pixbuf}.

Parameters: pixbuf The Pixbuf to use for the Image.

set

public void set(PixbufAnimation animation)
Sets to image to the given PixbufAnimation.

Parameters: animation The PixbufAnimation to use for this object.

set

public void set(String iconName, IconSize size)

set

public void set(IconSet iconSet, IconSize size)
Sets the image to displayian IconSet.

Parameters: iconSet The IconSet to use for the Image. size The IconSize to use for the Image.

set

public void set(GtkStockItem stockId, IconSize size)
Set the image to a Stock icon.

Parameters: stockId The id of the Stock icon to display. size The size of the icon.

set

public void set(String filename)
Sets the image from a file

Parameters: filename The filename for the image to load.

setPixelSize

public void setPixelSize(int pixelSize)