de.carne.jfx

Class ImageRegistry<T>

java.lang.Object

de.carne.jfx.ImageRegistry<T>

Type Parameters:

T - The registry key type.

public final class ImageRegistry<T>
extends java.lang.Object

Utility class providing an image registry.

Constructor Summary

Constructors

Constructor and Description
ImageRegistry()

Method Summary

Modifier and Type	Method and Description
javafx.scene.image.Image	getImage(T key) Get the largest registered image for a specific key.
javafx.scene.image.Image	getImage(T key, double space) Get the registered image for a specific key and space requirement.
java.util.List<javafx.scene.image.Image>	getImages(T key) Get all images registered for a specific key.
void	registerImage(T key, javafx.scene.image.Image image) Register an image.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageRegistry

public ImageRegistry()

Method Detail

registerImage

public void registerImage(T key,
                          javafx.scene.image.Image image)

Register an image.

Parameters:

key - The key to register the image for.

image - The image to register.

getImages

public java.util.List<javafx.scene.image.Image> getImages(T key)

Get all images registered for a specific key.

The resulting list ordered largest to smallest according to their image's space.

Parameters:

key - The key to get the images for.

Returns:

The list of registered images (may be empty).

getImage

public javafx.scene.image.Image getImage(T key)

Get the largest registered image for a specific key.

Parameters:

key - The key to get the image for.

Returns:

The found image or null if no image has been registered yet.

getImage

public javafx.scene.image.Image getImage(T key,
                                         double space)

Get the registered image for a specific key and space requirement.

Parameters:

key - The key to get the image for.

space - The space requirement to match.

Returns:

The found image or null if no image has been registered yet.