de.carne.jfx.scene.image

Class ImageRegistry<K>

java.lang.Object

de.carne.jfx.scene.image.ImageRegistry<K>

Type Parameters:

K - The key type to use.

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

Utility class providing a NavigableMap based data structure for registering and retrieving Image objects depending on their key and size.

Constructor Summary

Constructors

Constructor and Description
ImageRegistry(java.util.Comparator<K> comparator) Construct ImageRegistry.

Method Summary

Modifier and Type	Method and Description
@Nullable javafx.scene.image.Image	getImage(K key) Get the image associated with a specific key.
@Nullable javafx.scene.image.Image	getImage(K key, double size) Get the image associated with a specific key and nearest to a given size.
@Nullable javafx.scene.image.Image	getImage(K key, double size, @Nullable javafx.scene.image.Image def) Get the image associated with a specific key and nearest to a given size.
@Nullable javafx.scene.image.Image	getImage(K key, @Nullable javafx.scene.image.Image def) Get the image associated with a specific key.
javafx.scene.image.Image	registerImage(K key, javafx.scene.image.Image image) Register an image for a specific key.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageRegistry

public ImageRegistry(java.util.Comparator<K> comparator)

Construct ImageRegistry.

Parameters:

comparator - The Comparator to use for key comparison.

Method Detail

registerImage

public javafx.scene.image.Image registerImage(K key,
                                              javafx.scene.image.Image image)

Register an image for a specific key.

Parameters:

key - The key to associate the image with.

image - The image to register.

Returns:

The previously registered image, or null if no image has yet been registered for the submitted key and image size.

getImage

public @Nullable javafx.scene.image.Image getImage(K key)

Get the image associated with a specific key.

If multiple images with different sizes have been registered for the submitted key, the largest image is returned.

Parameters:

key - The key to get the image for.

Returns:

The found image, or null if no image has yet been registered for the submitted key.

getImage

public @Nullable javafx.scene.image.Image getImage(K key,
                                                   @Nullable javafx.scene.image.Image def)

Get the image associated with a specific key.

If multiple images with different sizes have been registered for the submitted key, the largest image is returned.

Parameters:

key - The key to get the image for.

def - The default image to return in case no image has hat been registered for the submitted key.

Returns:

The found image, or the default image if no image has yet been registered for the submitted key.

getImage

public @Nullable javafx.scene.image.Image getImage(K key,
                                                   double size)

Get the image associated with a specific key and nearest to a given size.

Parameters:

key - The key to get the image for.

size - The size to match by the image.

Returns:

The found image, or null if no image has yet been registered for the submitted key.

getImage

public @Nullable javafx.scene.image.Image getImage(K key,
                                                   double size,
                                                   @Nullable javafx.scene.image.Image def)

Get the image associated with a specific key and nearest to a given size.

Parameters:

key - The key to get the image for.

size - The size to match by the image.

def - The default image to return in case no image has hat been registered for the submitted key.

Returns:

The found image, or null if no image has yet been registered for the submitted key.