com.xmlmind.guiutil

Class ImageResource

java.lang.Object

com.xmlmind.guiutil.ImageResource

public final class ImageResource
extends Object

Utility functions sed to load an image from a resource.

The images loaded this way are possibly "marked" or resized to take into account the display scaling.

The images loaded this way are all cached.

This class is thread-safe.

See Also:

AWTUtil.getDisplayScaling(), IconResource

Method Summary

Modifier and Type	Method and Description
static void	appendHTMLImg(Class<?> cls, String name, StringBuilder buffer) Appends to specified buffer an <img> tag corresponding to specified image resource.
static void	appendHTMLImg(URL url, StringBuilder buffer) Appends to specified buffer an <img> tag corresponding to specified image resource.
static BufferedImage	colorizeImage(BufferedImage image, Color foreground, Color background) Returns a copy of specified image colorized using specified colors.
static Image	createDisabledImage(Image image) Create a "disabled" (grayed) image corresponding to specified image.
static Image	downscaleDoubleSizeImage(Image image) Not part of the public API: downscale specified image which is assumed to have been "marked" as being double size.
static void	drawDoubleSizeImage(Graphics g, Image image, int x, int y) Not part of the public API: draw specified image which is assumed to have been "marked" as being double size.
static void	drawImage(Graphics g, Image image, int x, int y) Draw specified image.
static void	drawPattern(Graphics g, Image pattern, int x0, int y0, int width, int height) Fills specified area width specified pattern.
static BufferedImage	get(Class<?> cls, String name) Returns a ready to use image loaded from specified resource.
static BufferedImage	get(Class<?> cls, String name, Color foreground, Color background) Returns a ready to use image loaded from specified image resource.
static BufferedImage	get(URL url) Returns a ready to use image loaded from specified URL.
static BufferedImage	get(URL url, Color foreground, Color background) Returns a ready to use image loaded from specified image URL.
static int	getImageHeight(Image image) Returns the height of specified image.
static int	getImageWidth(Image image) Returns the width of specified image.
static Image	horizontalFlipImage(Image image) Flip specified image horizontally.
static String	insertAtX2(String location)
static URL	insertAtX2(URL url)
static boolean	isDoubleSizeImage(Image image) Not part of the public API: tests wether specified image has been "marked" as being double size.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static BufferedImage get(Class<?> cls,
                                String name)

Returns a ready to use image loaded from specified resource.

Parameters:

cls - used to specify which ClassLoader must be used to access the image resource

name - name of image resource (example "images/logo.png")

Returns:

ready to use image or null if image resource is not found or cannot be successfully loaded

get

public static BufferedImage get(URL url)

Returns a ready to use image loaded from specified URL.

Parameters:

url - location of the image

insertAtX2

public static URL insertAtX2(URL url)

insertAtX2

public static String insertAtX2(String location)

get

public static BufferedImage get(Class<?> cls,
                                String name,
                                Color foreground,
                                Color background)

Returns a ready to use image loaded from specified image resource.

A bitonal image may be colorized using specified colors.

Parameters:

cls - the image resource belong to this class

name - filename of the image resource. Example: "myicon.png".

foreground - a new foreground color for the image. null means keep original foreground.

background - a new background color for the image. null means keep original background.

get

public static BufferedImage get(URL url,
                                Color foreground,
                                Color background)

Returns a ready to use image loaded from specified image URL.

A bitonal image may be colorized using specified colors.

Parameters:

url - location of the image

foreground - a new foreground color for the image. null means keep original foreground.

background - a new background color for the image. null means keep original background.

colorizeImage

public static BufferedImage colorizeImage(BufferedImage image,
                                          Color foreground,
                                          Color background)

Returns a copy of specified image colorized using specified colors.

Parameters:

image - image to be colorized.

foreground - a new foreground color for the image. null means keep original foreground.

background - a new background color for the image. null means keep original background.

appendHTMLImg

public static void appendHTMLImg(Class<?> cls,
                                 String name,
                                 StringBuilder buffer)

Appends to specified buffer an <img> tag corresponding to specified image resource.

This utility is useful to create "rich" tooltips.

appendHTMLImg

public static void appendHTMLImg(URL url,
                                 StringBuilder buffer)

Appends to specified buffer an <img> tag corresponding to specified image resource.

This utility is useful to create "rich" tooltips.

getImageWidth

public static int getImageWidth(Image image)

Returns the width of specified image.

ImportantThis method must be used for all the images loaded by ImageResource.

See Also:

getImageHeight(java.awt.Image), drawImage(java.awt.Graphics, java.awt.Image, int, int)

getImageHeight

public static int getImageHeight(Image image)

Returns the height of specified image.

ImportantThis method must be used for all the images loaded by ImageResource.

See Also:

getImageWidth(java.awt.Image), drawImage(java.awt.Graphics, java.awt.Image, int, int)

drawImage

public static void drawImage(Graphics g,
                             Image image,
                             int x,
                             int y)

Draw specified image.

ImportantThis method must be used for all the images loaded by ImageResource.

See Also:

getImageWidth(java.awt.Image), getImageHeight(java.awt.Image)

isDoubleSizeImage

public static boolean isDoubleSizeImage(Image image)

Not part of the public API: tests wether specified image has been "marked" as being double size.

This happens only on a Retina Mac.

downscaleDoubleSizeImage

public static Image downscaleDoubleSizeImage(Image image)

Not part of the public API: downscale specified image which is assumed to have been "marked" as being double size.

This happens only on a Retina Mac.

drawDoubleSizeImage

public static void drawDoubleSizeImage(Graphics g,
                                       Image image,
                                       int x,
                                       int y)

Not part of the public API: draw specified image which is assumed to have been "marked" as being double size.

This happens only on a Retina Mac.

drawPattern

public static void drawPattern(Graphics g,
                               Image pattern,
                               int x0,
                               int y0,
                               int width,
                               int height)

Fills specified area width specified pattern.

Parameters:

g - graphics object used to draw

pattern - fill pattern

x0 - X coordinate of the top/left of the area to be filled

y0 - Y coordinate of the top/left of the area to be filled

width - width of the area to be filled

height - height of the area to be filled

createDisabledImage

public static Image createDisabledImage(Image image)

Create a "disabled" (grayed) image corresponding to specified image.

Parameters:

image - an image

Returns:

"disabled" image when sucessfully created; original image otherwise

horizontalFlipImage

public static Image horizontalFlipImage(Image image)

Flip specified image horizontally.

Parameters:

image - image to be flipped

Returns:

flipped image