org.eclipse.fx.ui.controls.image

Interface MultiDimensionImage

All Known Implementing Classes:

DelegatingMultiDimensionImage, SingleMultiDimensionImage

public interface MultiDimensionImage

Interface describe an image capable of updating the image property depending on the required dimension

Since:

3.0

Method Summary

Modifier and Type	Method and Description
double	getRatio()
javafx.beans.property.ReadOnlyObjectProperty<javafx.scene.image.Image>	imageProperty()
javafx.beans.property.ReadOnlyDoubleProperty	ratioProperty()
static MultiDimensionImage	singleDimension(javafx.scene.image.Image image) Create a multi-dimension image who provides the same source image for any dimension
static <O> MultiDimensionImage	singleDimension(ThreadSynchronize threadSynchronize, javafx.scene.image.Image placeholder, O data, java.util.function.Function<O,javafx.scene.image.Image> imageComputer) Create a multi dimension image who is calculated lazily and uses the same image for any dimension
static <O> MultiDimensionImage	singleDimension(ThreadSynchronize threadSynchronize, javafx.scene.image.Image placeholder, O data, java.util.function.Function<O,javafx.scene.image.Image> imageComputer, <any> cache) Create a multi dimension image who is calculated lazily and uses the same image for any dimension
void	updateDimension(double w, double h) Update the dimension

Method Detail

getRatio

double getRatio()

Returns:

the ratio

ratioProperty

javafx.beans.property.ReadOnlyDoubleProperty ratioProperty()

Returns:

the ratio

imageProperty

javafx.beans.property.ReadOnlyObjectProperty<javafx.scene.image.Image> imageProperty()

Returns:

property who holds the current image

updateDimension

void updateDimension(double w,
                     double h)

Update the dimension

Parameters:

w - the width

h - the height

singleDimension

static MultiDimensionImage singleDimension(javafx.scene.image.Image image)

Create a multi-dimension image who provides the same source image for any dimension

Parameters:

image - the image

Returns:

a new image

singleDimension

static <O> MultiDimensionImage singleDimension(ThreadSynchronize threadSynchronize,
                                               javafx.scene.image.Image placeholder,
                                               O data,
                                               java.util.function.Function<O,javafx.scene.image.Image> imageComputer)

Create a multi dimension image who is calculated lazily and uses the same image for any dimension

Parameters:

threadSynchronize - helper to synchronize back to the UI thread

placeholder - a placeholder image to show while loading

data - the domain object used a the input to create the image

imageComputer - function to compute the image (called outside the UI-Thread)

Returns:

an image instance

singleDimension

static <O> MultiDimensionImage singleDimension(ThreadSynchronize threadSynchronize,
                                               javafx.scene.image.Image placeholder,
                                               O data,
                                               java.util.function.Function<O,javafx.scene.image.Image> imageComputer,
                                               <any> cache)

Create a multi dimension image who is calculated lazily and uses the same image for any dimension

Parameters:

threadSynchronize - helper to synchronize back to the UI thread

placeholder - a placeholder image to show while loading

data - the domain object used a the input to create the image

imageComputer - function to compute the image (called outside the UI-Thread)

cache - added cache

Returns:

an image instance