Top Description Fields Constructors Methods
org.eclipse.swt.graphics

public final Class Image

extends Resource
implements Drawable
Class Inheritance
All Implemented Interfaces
org.eclipse.swt.graphics.Drawable
Imports
java.io.*, org.eclipse.swt.*, org.eclipse.swt.internal.*, org.eclipse.swt.internal.DPIUtil.*, org.eclipse.swt.internal.cairo.*, org.eclipse.swt.internal.gtk.*
Instances of this class are graphics which have been prepared for display on a specific device. That is, they are ready to paint using methods such as GC.drawImage() and display on widgets with, for example, Button.setImage().

If loaded from a file format that supports it, an Image may have transparency, meaning that certain pixels are specified as being transparent when drawn. Examples of file formats that support transparency are GIF and PNG.

There are two primary ways to use Images. The first is to load a graphic file from disk and create an Image from it. This is done using an Image constructor, for example: 

   Image i = new Image(device, "C:\\graphic.bmp");
A graphic file may contain a color table specifying which colors the image was intended to possess. In the above example, these colors will be mapped to the closest available color in SWT. It is possible to get more control over the mapping of colors as the image is being created, using code of the form: 
   ImageData data = new ImageData("C:\\graphic.bmp");
   RGB[] rgbs = data.getRGBs();
   // At this point, rgbs contains specifications of all
   // the colors contained within this image. You may
   // allocate as many of these colors as you wish by
   // using the Color constructor Color(RGB), then
   // create the image:
   Image i = new Image(device, data);

Applications which require even greater control over the image loading process should use the support provided in class ImageLoader.

Application code must explicitly invoke the Image.dispose() method to release the operating system resources managed by each instance when those instances are no longer required.

See Also
Color, ImageData, ImageLoader, Image snippets, SWT Examples: GraphicsExample, ImageAnalyzer, Sample code and further information

Field Summary

Modifier and TypeField and Description
private int
currentDeviceZoom

Attribute to cache current device zoom level

pack-priv static final int
DEFAULT_SCANLINE_PAD

Specifies the default scanline padding.

pack-priv int
height

The height of the image.

private ImageDataProvider
imageDataProvider

ImageDataProvider to provide ImageData at various Zoom levels

private ImageFileNameProvider
imageFileNameProvider

ImageFileNameProvider to provide file names at various Zoom levels

public long
mask

The handle to the OS mask resource.

pack-priv GC
memGC

The GC the image is currently selected in.

private int
styleFlag

Style flag used to differentiate normal, gray-scale and disabled images based on image data providers.

public long
surface

The handle to the OS cairo surface resource.

pack-priv int
transparentPixel

specifies the transparent pixel

public int
type

specifies whether the receiver is a bitmap or an icon (one of SWT.BITMAP, SWT.ICON)

Important Note

This field is not part of the SWT public API.

pack-priv int
width

The width of the image.

Inherited from org.eclipse.swt.graphics.Resource:
device

Constructor Summary

AccessConstructor and Description
pack-priv
Image(Device device)

public
Image(Device
the device on which to create the image
device, int
the width of the new image
width, int
the height of the new image
height)

Constructs an empty instance of this class with the specified width and height.

public
Image(Device
the device on which to create the image
device, Image
the image to use as the source
srcImage, int
the style, either IMAGE_COPY, IMAGE_DISABLE or IMAGE_GRAY
flag)

Constructs a new instance of this class based on the provided image, with an appearance that varies depending on the value of the flag.

public
Image(Device
the device on which to create the image
device, Rectangle
a rectangle specifying the image's width and height (must not be null)
bounds)

Constructs an empty instance of this class with the width and height of the specified rectangle.

public
Image(Device
the device on which to create the image
device, ImageData
the image data to create the image from (must not be null)
data)

Constructs an instance of this class from the given ImageData.

public
Image(Device
the device on which to create the icon
device, ImageData
the color data for the icon
source, ImageData
the mask data for the icon
mask)

Constructs an instance of this class, whose type is SWT.ICON, from the two given ImageData objects.

public
Image(Device
the device on which to create the image
device, InputStream
the input stream to load the image from
stream)

Constructs an instance of this class by loading its representation from the specified input stream.

public
Image(Device
the device on which to create the image
device, String
the name of the file to load the image from
filename)

Constructs an instance of this class by loading its representation from the file with the specified name.

public
Image(Device
the device on which to create the image
device, ImageFileNameProvider
the ImageFileNameProvider object that is to be used to get the file name
imageFileNameProvider)

Constructs an instance of this class by loading its representation from the file retrieved from the ImageFileNameProvider.

public
Image(Device
the device on which to create the image
device, ImageDataProvider
the ImageDataProvider object that is to be used to get the ImageData
imageDataProvider)

Constructs an instance of this class by loading its representation from the ImageData retrieved from the ImageDataProvider.

Method Summary

Modifier and TypeMethod and Description
pack-priv void
createFromPixbuf(int type, long pixbuf)

pack-priv void
createMask()

Create the receiver's mask if necessary.

pack-priv void
createSurface()

pack-priv void
destroy()

Overrides org.eclipse.swt.graphics.Resource.destroy.

pack-priv void
destroyMask()

Destroy the receiver's mask if it exists.

public boolean

Returns:

true if the object is the same as this object and false otherwise
equals(Object
the object to compare with this object
object)

Overrides java.lang.Object.equals.

Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
public Color

Returns:

the background color of the image, or null if there is no transparency in the image
getBackground()

Returns the color to which to map the transparent pixel, or null if the receiver has no transparent pixel.

public Rectangle

Returns:

a rectangle specifying the image's bounds in points.
getBounds()

Returns the bounds of the receiver.

public Rectangle

Returns:

a rectangle specifying the image's bounds in pixels.
getBoundsInPixels()

Deprecated This API doesn't serve the purpose in an environment having multiple monitors with different DPIs, hence deprecated.
Returns the bounds of the receiver.
public ImageData

Returns:

an ImageData containing the image's data and attributes at 100% zoom level.
getImageData()

Returns an ImageData based on the receiver.

public ImageData

Returns:

an ImageData containing the image's data and attributes at the given zoom level
getImageData(int
The zoom level in % of the standard resolution (which is 1 physical monitor pixel == 1 SWT logical point). Typically 100, 150, or 200.
zoom)

Returns an ImageData for the given zoom level based on the receiver.

public ImageData

Returns:

an ImageData containing the image's data and attributes at the current zoom level.
getImageDataAtCurrentZoom()

Deprecated This API doesn't serve the purpose in an environment having multiple monitors with different DPIs, hence deprecated.
Returns an ImageData based on the receiver.
public static Image
gtk_new(Device
the device on which to allocate the color
device, int
the type of the image (SWT.BITMAP or SWT.ICON)
type, long
the OS handle for the image
imageHandle, long
the OS handle for the image mask
mask)

Invokes platform specific functionality to allocate a new image.

public static Image
gtk_new_from_pixbuf(Device
the device on which to allocate the color
device, int
the type of the image (SWT.BITMAP or SWT.ICON)
type, long
an GdkPixbuf
pixbuf)

Invokes platform specific functionality to allocate a new image.

public int

Returns:

the receiver's hash
hashCode()

Overrides java.lang.Object.hashCode.

Returns an integer hash code for the receiver.
pack-priv void
init(int width, int height)

pack-priv void
init(ImageData image)

pack-priv void
initNative(String filename)

public void
internal_dispose_GC(long
the platform specific GC handle
hDC, GCData
the platform specific GC data
data)

Implements org.eclipse.swt.graphics.Drawable.internal_dispose_GC.

Invokes platform specific functionality to dispose a GC handle.
public boolean
internal_gtk_refreshImageForZoom()

Refreshes the image for the current device scale factor.

public long

Returns:

the platform specific GC handle
internal_new_GC(GCData
the platform specific GC data
data)

Implements org.eclipse.swt.graphics.Drawable.internal_new_GC.

Invokes platform specific functionality to allocate a new GC handle.
public boolean

Returns:

true when the image is disposed and false otherwise
isDisposed()

Implements abstract org.eclipse.swt.graphics.Resource.isDisposed.

Returns true if the image has been disposed, and false otherwise.
pack-priv boolean

Returns:

true if image is refreshed
refreshImageForZoom()

Refresh the Image based on the zoom level, if required.

public void
setBackground(Color
the color to use when a transparent pixel is specified
color)

Sets the color to which to map the transparent pixel.

public String

Returns:

a string representation of the receiver
toString()

Overrides java.lang.Object.toString.

Returns a string containing a concise, human-readable description of the receiver.
Inherited from org.eclipse.swt.graphics.Resource:
disposegetDeviceignoreNonDisposedinitinitNonDisposeTrackingsetNonDisposeHandler

Field Detail

currentDeviceZoomback to summary
private int currentDeviceZoom

Attribute to cache current device zoom level

DEFAULT_SCANLINE_PADback to summary
pack-priv static final int DEFAULT_SCANLINE_PAD

Specifies the default scanline padding.

heightback to summary
pack-priv int height

The height of the image.

imageDataProviderback to summary
private ImageDataProvider imageDataProvider

ImageDataProvider to provide ImageData at various Zoom levels

imageFileNameProviderback to summary
private ImageFileNameProvider imageFileNameProvider

ImageFileNameProvider to provide file names at various Zoom levels

maskback to summary
public long mask

The handle to the OS mask resource. (Warning: This field is platform dependent)

Important Note

This field is not part of the SWT public API. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms and should never be accessed from application code.

memGCback to summary
pack-priv GC memGC

The GC the image is currently selected in.

styleFlagback to summary
private int styleFlag

Style flag used to differentiate normal, gray-scale and disabled images based on image data providers. Without this, a normal and a disabled image of the same image data provider would be considered equal.

surfaceback to summary
public long surface

The handle to the OS cairo surface resource. (Warning: This field is platform dependent)

Important Note

This field is not part of the SWT public API. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms and should never be accessed from application code.

transparentPixelback to summary
pack-priv int transparentPixel

specifies the transparent pixel

typeback to summary
public int type

specifies whether the receiver is a bitmap or an icon (one of SWT.BITMAP, SWT.ICON)

Important Note

This field is not part of the SWT public API. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms and should never be accessed from application code.

widthback to summary
pack-priv int width

The width of the image.

Constructor Detail

Imageback to summary
pack-priv Image(Device device)
Imageback to summary
public Image(Device device, int width, int height)

Constructs an empty instance of this class with the specified width and height. The result may be drawn upon by creating a GC and using any of its drawing operations, as shown in the following example: 

   Image i = new Image(device, width, height);
   GC gc = new GC(i);
   gc.drawRectangle(0, 0, 50, 50);
   gc.dispose();

Note

Some platforms may have a limitation on the size of image that can be created (size depends on width, height, and depth). For example, Windows 95, 98, and ME do not allow images larger than 16M.

You must dispose the image when it is no longer required.

Parameters
device:Device

the device on which to create the image

width:int

the width of the new image

height:int

the height of the new image

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if device is null and there is no current device
  • ERROR_INVALID_ARGUMENT - if either the width or height is negative or zero
SWTError:
  • ERROR_NO_HANDLES if a handle could not be obtained for image creation
See Also
dispose()
Imageback to summary
public Image(Device device, Image srcImage, int flag)

Constructs a new instance of this class based on the provided image, with an appearance that varies depending on the value of the flag. The possible flag values are:

SWT#IMAGE_COPY
the result is an identical copy of srcImage
SWT#IMAGE_DISABLE
the result is a copy of srcImage which has a disabled look
SWT#IMAGE_GRAY
the result is a copy of srcImage which has a gray scale look

You must dispose the image when it is no longer required.

Parameters
device:Device

the device on which to create the image

srcImage:Image

the image to use as the source

flag:int

the style, either IMAGE_COPY, IMAGE_DISABLE or IMAGE_GRAY

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if device is null and there is no current device
  • ERROR_NULL_ARGUMENT - if srcImage is null
  • ERROR_INVALID_ARGUMENT - if the flag is not one of IMAGE_COPY, IMAGE_DISABLE or IMAGE_GRAY
  • ERROR_INVALID_ARGUMENT - if the image has been disposed
SWTException:
  • ERROR_INVALID_IMAGE - if the image is not a bitmap or an icon, or is otherwise in an invalid state
  • ERROR_UNSUPPORTED_DEPTH - if the depth of the image is not supported
SWTError:
  • ERROR_NO_HANDLES if a handle could not be obtained for image creation
See Also
dispose()
Imageback to summary
public Image(Device device, Rectangle bounds)

Constructs an empty instance of this class with the width and height of the specified rectangle. The result may be drawn upon by creating a GC and using any of its drawing operations, as shown in the following example: 

   Image i = new Image(device, boundsRectangle);
   GC gc = new GC(i);
   gc.drawRectangle(0, 0, 50, 50);
   gc.dispose();

Note

Some platforms may have a limitation on the size of image that can be created (size depends on width, height, and depth). For example, Windows 95, 98, and ME do not allow images larger than 16M.

You must dispose the image when it is no longer required.

Parameters
device:Device

the device on which to create the image

bounds:Rectangle

a rectangle specifying the image's width and height (must not be null)

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if device is null and there is no current device
  • ERROR_NULL_ARGUMENT - if the bounds rectangle is null
  • ERROR_INVALID_ARGUMENT - if either the rectangle's width or height is negative
SWTError:
  • ERROR_NO_HANDLES if a handle could not be obtained for image creation
See Also
dispose()
Imageback to summary
public Image(Device device, ImageData data)

Constructs an instance of this class from the given ImageData.

You must dispose the image when it is no longer required.

Parameters
device:Device

the device on which to create the image

data:ImageData

the image data to create the image from (must not be null)

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if device is null and there is no current device
  • ERROR_NULL_ARGUMENT - if the image data is null
SWTException:
  • ERROR_UNSUPPORTED_DEPTH - if the depth of the ImageData is not supported
SWTError:
  • ERROR_NO_HANDLES if a handle could not be obtained for image creation
See Also
dispose()
Imageback to summary
public Image(Device device, ImageData source, ImageData mask)

Constructs an instance of this class, whose type is SWT.ICON, from the two given ImageData objects. The two images must be the same size. Pixel transparency in either image will be ignored.

The mask image should contain white wherever the icon is to be visible, and black wherever the icon is to be transparent. In addition, the source image should contain black wherever the icon is to be transparent.

You must dispose the image when it is no longer required.

Parameters
device:Device

the device on which to create the icon

source:ImageData

the color data for the icon

mask:ImageData

the mask data for the icon

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if device is null and there is no current device
  • ERROR_NULL_ARGUMENT - if either the source or mask is null
  • ERROR_INVALID_ARGUMENT - if source and mask are different sizes
SWTError:
  • ERROR_NO_HANDLES if a handle could not be obtained for image creation
See Also
dispose()
Imageback to summary
public Image(Device device, InputStream stream)

Constructs an instance of this class by loading its representation from the specified input stream. Throws an error if an error occurs while loading the image, or if the result is an image of an unsupported type. Application code is still responsible for closing the input stream.

This constructor is provided for convenience when loading a single image only. If the stream contains multiple images, only the first one will be loaded. To load multiple images, use ImageLoader.load().

This constructor may be used to load a resource as follows: 

    static Image loadImage (Display display, Class clazz, String string) {
         InputStream stream = clazz.getResourceAsStream (string);
         if (stream == null) return null;
         Image image = null;
         try {
              image = new Image (display, stream);
         } catch (SWTException ex) {
         } finally {
              try {
                   stream.close ();
              } catch (IOException ex) {}
         }
         return image;
    }

You must dispose the image when it is no longer required.

Parameters
device:Device

the device on which to create the image

stream:InputStream

the input stream to load the image from

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if device is null and there is no current device
  • ERROR_NULL_ARGUMENT - if the stream is null
SWTException:
  • ERROR_IO - if an IO error occurs while reading from the stream
  • ERROR_INVALID_IMAGE - if the image stream contains invalid data
  • ERROR_UNSUPPORTED_DEPTH - if the image stream describes an image with an unsupported depth
  • ERROR_UNSUPPORTED_FORMAT - if the image stream contains an unrecognized format
SWTError:
  • ERROR_NO_HANDLES if a handle could not be obtained for image creation
See Also
dispose()
Imageback to summary
public Image(Device device, String filename)

Constructs an instance of this class by loading its representation from the file with the specified name. Throws an error if an error occurs while loading the image, or if the result is an image of an unsupported type.

This constructor is provided for convenience when loading a single image only. If the specified file contains multiple images, only the first one will be used.

You must dispose the image when it is no longer required.

Parameters
device:Device

the device on which to create the image

filename:String

the name of the file to load the image from

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if device is null and there is no current device
  • ERROR_NULL_ARGUMENT - if the file name is null
SWTException:
  • ERROR_IO - if an IO error occurs while reading from the file
  • ERROR_INVALID_IMAGE - if the image file contains invalid data
  • ERROR_UNSUPPORTED_DEPTH - if the image file describes an image with an unsupported depth
  • ERROR_UNSUPPORTED_FORMAT - if the image file contains an unrecognized format
SWTError:
  • ERROR_NO_HANDLES if a handle could not be obtained for image creation
See Also
dispose()
Imageback to summary
public Image(Device device, ImageFileNameProvider imageFileNameProvider)

Constructs an instance of this class by loading its representation from the file retrieved from the ImageFileNameProvider. Throws an error if an error occurs while loading the image, or if the result is an image of an unsupported type.

This constructor is provided for convenience for loading image as per DPI level.

Parameters
device:Device

the device on which to create the image

imageFileNameProvider:ImageFileNameProvider

the ImageFileNameProvider object that is to be used to get the file name

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if device is null and there is no current device
  • ERROR_NULL_ARGUMENT - if the ImageFileNameProvider is null
  • ERROR_INVALID_ARGUMENT - if the fileName provided by ImageFileNameProvider is null at 100% zoom
SWTException:
  • ERROR_IO - if an IO error occurs while reading from the file
  • ERROR_INVALID_IMAGE - if the image file contains invalid data
  • ERROR_UNSUPPORTED_DEPTH - if the image file describes an image with an unsupported depth
  • ERROR_UNSUPPORTED_FORMAT - if the image file contains an unrecognized format
SWTError:
  • ERROR_NO_HANDLES if a handle could not be obtained for image creation
Since
3.104
Imageback to summary
public Image(Device device, ImageDataProvider imageDataProvider)

Constructs an instance of this class by loading its representation from the ImageData retrieved from the ImageDataProvider. Throws an error if an error occurs while loading the image, or if the result is an image of an unsupported type.

This constructor is provided for convenience for loading image as per DPI level.

Parameters
device:Device

the device on which to create the image

imageDataProvider:ImageDataProvider

the ImageDataProvider object that is to be used to get the ImageData

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if device is null and there is no current device
  • ERROR_NULL_ARGUMENT - if the ImageDataProvider is null
  • ERROR_INVALID_ARGUMENT - if the ImageData provided by ImageDataProvider is null at 100% zoom
SWTException:
  • ERROR_IO - if an IO error occurs while reading from the file
  • ERROR_INVALID_IMAGE - if the image file contains invalid data
  • ERROR_UNSUPPORTED_DEPTH - if the image file describes an image with an unsupported depth
  • ERROR_UNSUPPORTED_FORMAT - if the image file contains an unrecognized format
SWTError:
  • ERROR_NO_HANDLES if a handle could not be obtained for image creation
Since
3.104

Method Detail

createFromPixbufback to summary
pack-priv void createFromPixbuf(int type, long pixbuf)
createMaskback to summary
pack-priv void createMask()

Create the receiver's mask if necessary.

createSurfaceback to summary
pack-priv void createSurface()
destroyback to summary
pack-priv void destroy()

Overrides org.eclipse.swt.graphics.Resource.destroy.

Annotations
@Override
destroyMaskback to summary
pack-priv void destroyMask()

Destroy the receiver's mask if it exists.

equalsback to summary
public boolean equals(Object object)

Overrides java.lang.Object.equals.

Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.

Parameters
object:Object

the object to compare with this object

Returns:boolean

true if the object is the same as this object and false otherwise

Annotations
@Override
See Also
hashCode
getBackgroundback to summary
public Color getBackground()

Returns the color to which to map the transparent pixel, or null if the receiver has no transparent pixel.

There are certain uses of Images that do not support transparency (for example, setting an image into a button or label). In these cases, it may be desired to simulate transparency by using the background color of the widget to paint the transparent pixels of the image. Use this method to check which color will be used in these cases in place of transparency. This value may be set with setBackground().

Returns:Color

the background color of the image, or null if there is no transparency in the image

Exceptions
SWTException:
  • ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
getBoundsback to summary
public Rectangle getBounds()

Returns the bounds of the receiver. The rectangle will always have x and y values of 0, and the width and height of the image.

Returns:Rectangle

a rectangle specifying the image's bounds in points.

Exceptions
SWTException:
  • ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
  • ERROR_INVALID_IMAGE - if the image is not a bitmap or an icon
getBoundsInPixelsback to summary
public Rectangle getBoundsInPixels()

Deprecated

This API doesn't serve the purpose in an environment having multiple monitors with different DPIs, hence deprecated.

Returns the bounds of the receiver. The rectangle will always have x and y values of 0, and the width and height of the image in pixels.

Returns:Rectangle

a rectangle specifying the image's bounds in pixels.

Annotations
@Deprecated
Exceptions
SWTException:
  • ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
  • ERROR_INVALID_IMAGE - if the image is not a bitmap or an icon
Since
3.105
getImageDataback to summary
public ImageData getImageData()

Returns an ImageData based on the receiver. Modifications made to this ImageData will not affect the Image.

Returns:ImageData

an ImageData containing the image's data and attributes at 100% zoom level.

Exceptions
SWTException:
  • ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
  • ERROR_INVALID_IMAGE - if the image is not a bitmap or an icon
See Also
ImageData
getImageDataback to summary
public ImageData getImageData(int zoom)

Returns an ImageData for the given zoom level based on the receiver.

Note that this method is mainly intended to be used by custom implementations of ImageDataProvider that draw a composite image at the requested zoom level based on other images. For custom zoom levels, the image data may be an auto-scaled version of the native image and may look more blurred or mangled than expected.

Modifications made to the returned ImageData will not affect this Image.

Parameters
zoom:int

The zoom level in % of the standard resolution (which is 1 physical monitor pixel == 1 SWT logical point). Typically 100, 150, or 200.

Returns:ImageData

an ImageData containing the image's data and attributes at the given zoom level

Exceptions
SWTException:
  • ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
  • ERROR_INVALID_IMAGE - if the image is not a bitmap or an icon
Since
3.106
getImageDataAtCurrentZoomback to summary
public ImageData getImageDataAtCurrentZoom()

Deprecated

This API doesn't serve the purpose in an environment having multiple monitors with different DPIs, hence deprecated. Use getImageData(int) instead.

Returns an ImageData based on the receiver. Modifications made to this ImageData will not affect the Image.

Returns:ImageData

an ImageData containing the image's data and attributes at the current zoom level.

Annotations
@Deprecated
Exceptions
SWTException:
  • ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
  • ERROR_INVALID_IMAGE - if the image is not a bitmap or an icon
Since
3.105
See Also
ImageData
gtk_newback to summary
public static Image gtk_new(Device device, int type, long imageHandle, long mask)

Invokes platform specific functionality to allocate a new image.

Important Note

This method is not part of the public API for Image. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms, and should never be called from application code.

Parameters
device:Device

the device on which to allocate the color

type:int

the type of the image (SWT.BITMAP or SWT.ICON)

imageHandle:long

the OS handle for the image

mask:long

the OS handle for the image mask

gtk_new_from_pixbufback to summary
public static Image gtk_new_from_pixbuf(Device device, int type, long pixbuf)

Invokes platform specific functionality to allocate a new image.

Important Note

This method is not part of the public API for Image. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms, and should never be called from application code.

Parameters
device:Device

the device on which to allocate the color

type:int

the type of the image (SWT.BITMAP or SWT.ICON)

pixbuf:long

an GdkPixbuf

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Returns an integer hash code for the receiver. Any two objects that return true when passed to equals must return the same value for this method.

Returns:int

the receiver's hash

Annotations
@Override
See Also
equals
initback to summary
pack-priv void init(int width, int height)
initback to summary
pack-priv void init(ImageData image)
initNativeback to summary
pack-priv void initNative(String filename)
internal_dispose_GCback to summary
public void internal_dispose_GC(long hDC, GCData data)

Implements org.eclipse.swt.graphics.Drawable.internal_dispose_GC.

Invokes platform specific functionality to dispose a GC handle.

Important Note

This method is not part of the public API for Image. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms, and should never be called from application code.

Parameters
hDC:long

the platform specific GC handle

data:GCData

the platform specific GC data

Annotations
@Override
internal_gtk_refreshImageForZoomback to summary
public boolean internal_gtk_refreshImageForZoom()

Refreshes the image for the current device scale factor.

Important Note

This function is not part of the SWT public API. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms and should never be used from application code.

internal_new_GCback to summary
public long internal_new_GC(GCData data)

Implements org.eclipse.swt.graphics.Drawable.internal_new_GC.

Invokes platform specific functionality to allocate a new GC handle.

Important Note

This method is not part of the public API for Image. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms, and should never be called from application code.

Parameters
data:GCData

the platform specific GC data

Returns:long

the platform specific GC handle

Annotations
@Override
isDisposedback to summary
public boolean isDisposed()

Implements abstract org.eclipse.swt.graphics.Resource.isDisposed.

Returns true if the image has been disposed, and false otherwise.

This method gets the dispose state for the image. When an image has been disposed, it is an error to invoke any other method (except dispose()) using the image.

Returns:boolean

true when the image is disposed and false otherwise

Annotations
@Override
refreshImageForZoomback to summary
pack-priv boolean refreshImageForZoom()

Refresh the Image based on the zoom level, if required.

Returns:boolean

true if image is refreshed

setBackgroundback to summary
public void setBackground(Color color)

Sets the color to which to map the transparent pixel.

There are certain uses of Images that do not support transparency (for example, setting an image into a button or label). In these cases, it may be desired to simulate transparency by using the background color of the widget to paint the transparent pixels of the image. This method specifies the color that will be used in these cases. For example:

   Button b = new Button();
   image.setBackground(b.getBackground());
   b.setImage(image);

The image may be modified by this operation (in effect, the transparent regions may be filled with the supplied color). Hence this operation is not reversible and it is not legal to call this function twice or with a null argument.

This method has no effect if the receiver does not have a transparent pixel value.

Parameters
color:Color

the color to use when a transparent pixel is specified

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if the color is null
  • ERROR_INVALID_ARGUMENT - if the color has been disposed
SWTException:
  • ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Returns a string containing a concise, human-readable description of the receiver.

Returns:String

a string representation of the receiver

Annotations
@Override