org.eclipse.fx.ui.controls.image

Class DelegatingMultiDimensionImage

java.lang.Object

org.eclipse.fx.ui.controls.image.DelegatingMultiDimensionImage

All Implemented Interfaces:

MultiDimensionImage

public class DelegatingMultiDimensionImage
extends java.lang.Object
implements MultiDimensionImage

A MultiDimensionImage image who (asynchronously) calculates an image for a provided dimension

Since:

3.0

Property Summary

Type	Property and Description
javafx.beans.property.ReadOnlyObjectProperty<javafx.scene.image.Image>	image
javafx.beans.property.ReadOnlyDoubleProperty	ratio

Method Summary

Modifier and Type	Method and Description
static DelegatingMultiDimensionImage	async(ThreadSynchronize threadSync, <any> imageProvider) Create an image who calculates the image asynchronously
double	getRatio() Gets the value of the property ratio.
javafx.beans.property.ReadOnlyObjectProperty<javafx.scene.image.Image>	imageProperty()
javafx.beans.property.ReadOnlyDoubleProperty	ratioProperty()
static DelegatingMultiDimensionImage	sync(<any> imageProvider) Create an image who calculates the image synchronously
void	updateDimension(double w, double h) Update the dimension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.fx.ui.controls.image.MultiDimensionImage

singleDimension, singleDimension, singleDimension

Property Detail

ratio

public javafx.beans.property.ReadOnlyDoubleProperty ratioProperty

Specified by:

ratioProperty in interface MultiDimensionImage

Returns:

the ratio

See Also:

getRatio()

image

public javafx.beans.property.ReadOnlyObjectProperty<javafx.scene.image.Image> imageProperty

Specified by:

imageProperty in interface MultiDimensionImage

Returns:

property who holds the current image

Method Detail

getRatio

public double getRatio()

Gets the value of the property ratio.

Specified by:

getRatio in interface MultiDimensionImage

Returns:

the ratio

ratioProperty

public javafx.beans.property.ReadOnlyDoubleProperty ratioProperty()

Specified by:

ratioProperty in interface MultiDimensionImage

Returns:

the ratio

See Also:

getRatio()

imageProperty

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

Specified by:

imageProperty in interface MultiDimensionImage

Returns:

property who holds the current image

updateDimension

public void updateDimension(double w,
                            double h)

Description copied from interface: MultiDimensionImage

Update the dimension

Specified by:

updateDimension in interface MultiDimensionImage

Parameters:

w - the width

h - the height

async

public static DelegatingMultiDimensionImage async(ThreadSynchronize threadSync,
                                                  <any> imageProvider)

Create an image who calculates the image asynchronously

Parameters:

threadSync - strategy to synchronize back to a the thread

imageProvider - function producing a CompletableFuture calculating the image in a background task

Returns:

an image instance

sync

public static DelegatingMultiDimensionImage sync(<any> imageProvider)

Create an image who calculates the image synchronously

Parameters:

imageProvider - the provider

Returns:

a new image instance