org.openide.util

Class ImageUtilities

java.lang.Object

org.openide.util.ImageUtilities

public final class ImageUtilities
extends Object

Useful static methods for manipulation with images/icons, results are cached.

Images can be represented as instances of either Image or Icon. For best results on HiDPI displays, clients should use the ImageUtilities.image2Icon(Image) method provided by this class when converting an Image to an Icon, rather than constructing ImageIcon instances themselves. When doing manual painting, clients should use Icon.paintIcon(Component, Graphics, int, int) rather than Graphics.drawImage(Image, int, int, ImageObserver).

Since:

7.15

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_URL Property that holds URL of the image bits.

Method Summary

Modifier and Type	Method and Description
static Image	addToolTipToImage(Image image, String text) Add text to tool tip for given image (creates new or returns cached, original remains unmodified) Text can contain HTML tags e.g.
static Image	assignToolTipToImage(Image image, String text) Assign tool tip text to given image (creates new or returns cached, original remains unmodified) Text can contain HTML tags e.g.
static Icon	createDisabledIcon(Icon icon) Creates disabled (color saturation lowered) icon.
static Image	createDisabledImage(Image image) Creates disabled (color saturation lowered) image.
static URL	findImageBaseURL(Image image) Attempts to find image's URL, if it is defined.
static String	getImageToolTip(Image image) Get tool tip text for given image
static Image	icon2Image(Icon icon) Converts given icon to a Image.
static Icon	image2Icon(Image image) Converts given image to an icon.
static Image	loadImage(String resourceID) Loads an image from the specified resource ID.
static Image	loadImage(String resource, boolean localized) Loads an image based on resource path.
static ImageIcon	loadImageIcon(String resource, boolean localized) Loads an icon based on resource path.
static Image	mergeImages(Image image1, Image image2, int x, int y) This method merges two images into the new one.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_URL

public static final String PROPERTY_URL

Property that holds URL of the image bits.

Since:

9.24

See Also:

Constant Field Values

Method Detail

loadImage

public static final Image loadImage(String resourceID)

Loads an image from the specified resource ID. The image is loaded using the "system" classloader registered in Lookup.

If the default lookup contains a service provider for the SVGLoader interface, and there exists an SVG version of the requested image (e.g. "icon.svg" exists when "icon.png" was requested), the SVG version will be loaded instead of the originally requested bitmap. SVG images can also be requested directly. The SVG document's root element must contain explicit width/height attributes. An SVG loader implementation can be installed via the optional openide.util.ui.svg module.

To paint SVG images at arbitrary resolutions, convert the returned Image to an Icon using ImageUtilities.image2Icon(Image), and set an appropriate transform on the Graphics2D instance passed to Icon.paintIcon(Component, Graphics, int, int). When painting on HiDPI-capable Graphics2D instances provided by Swing, the appropriate transform will already be in place.

Parameters:

resourceID - resource path of the icon (no initial slash)

Returns:

icon's Image, or null, if the icon cannot be loaded.

loadImage

public static final Image loadImage(String resource,
                                    boolean localized)

Loads an image based on resource path. Exactly like ImageUtilities.loadImage(String) but may do a localized search. For example, requesting org/netbeans/modules/foo/resources/foo.gif might actually find org/netbeans/modules/foo/resources/foo_ja.gif or org/netbeans/modules/foo/resources/foo_mybranding.gif.

Caching of loaded images can be used internally to improve performance.

Since version 8.12 the returned image object responds to call image.getProperty(ImageUtilities.PROPERTY_URL, null) by returning the internal URL of the found and loaded resource. Convenience method ImageUtilities.findImageBaseURL(java.awt.Image) should be used in preference to direct property access.

If the current look and feel is 'dark' (UIManager.getBoolean("nb.dark.theme")) then the method first attempts to load image <original file name>_dark.<original extension>. If such file doesn't exist the default one is loaded instead.

Parameters:

resource - resource path of the image (no initial slash)

localized - true for localized search

Returns:

icon's Image or null if the icon cannot be loaded

loadImageIcon

public static final ImageIcon loadImageIcon(String resource,
                                            boolean localized)

Loads an icon based on resource path. Similar to ImageUtilities.loadImage(String, boolean), returns ImageIcon instead of Image.

If the current look and feel is 'dark' (UIManager.getBoolean("nb.dark.theme")) then the method first attempts to load image <original file name>_dark.<original extension>. If such file doesn't exist the default one is loaded instead.

Parameters:

resource - resource path of the icon (no initial slash)

localized - localized resource should be used

Returns:

ImageIcon or null, if the icon cannot be loaded.

Since:

7.22

mergeImages

public static final Image mergeImages(Image image1,
                                      Image image2,
                                      int x,
                                      int y)

This method merges two images into the new one. The second image is drawn over the first one with its top-left corner at x, y. Images need not be of the same size. New image will have a size of max(second image size + top-left corner, first image size). Method is used mostly when second image contains transparent pixels (e.g. for badging). Method that attempts to find the merged image in the cache first, then creates the image if it was not found.

Parameters:

image1 - underlying image

image2 - second image

x - x position of top-left corner

y - y position of top-left corner

Returns:

new merged image

image2Icon

public static final Icon image2Icon(Image image)

Converts given image to an icon.

Parameters:

image - to be converted

Returns:

icon corresponding icon

icon2Image

public static final Image icon2Image(Icon icon)

Converts given icon to a Image.

A scalable Icon instance can always be recovered by passing the returned Image to ImageUtilities.image2Icon(Image) again, i.e. for painting on HiDPI screens.

Parameters:

icon - Icon to be converted.

assignToolTipToImage

public static final Image assignToolTipToImage(Image image,
                                               String text)

Assign tool tip text to given image (creates new or returns cached, original remains unmodified) Text can contain HTML tags e.g. "<b>my</b> text"

Parameters:

image - image to which tool tip should be set

text - tool tip text

Returns:

Image with attached tool tip

getImageToolTip

public static final String getImageToolTip(Image image)

Get tool tip text for given image

Parameters:

image - image which is asked for tool tip text

Returns:

String containing attached tool tip text

addToolTipToImage

public static final Image addToolTipToImage(Image image,
                                            String text)

Add text to tool tip for given image (creates new or returns cached, original remains unmodified) Text can contain HTML tags e.g. "<b>my</b> text"

Parameters:

text - text to add to tool tip

Returns:

Image with attached tool tip

createDisabledIcon

public static Icon createDisabledIcon(Icon icon)

Creates disabled (color saturation lowered) icon. Icon image conversion is performed lazily.

Parameters:

icon - original icon used for conversion

Returns:

less saturated Icon

Since:

7.28

createDisabledImage

public static Image createDisabledImage(Image image)

Creates disabled (color saturation lowered) image.

Parameters:

image - original image used for conversion

Returns:

less saturated Image

Since:

7.28

findImageBaseURL

public static URL findImageBaseURL(Image image)

Attempts to find image's URL, if it is defined. Image Observer features are not used during this call, the property is assumed to be populated. Note that the URL may be specific for a localization or branding, and may be the same for bare and badged icons.

Parameters:

image - image to inspect

Returns:

image's URL or null if not defined.

Since:

9.24