org.eclipse.fx.ui.controls.image

Class SingleMultiDimensionImage

java.lang.Object

org.eclipse.fx.ui.controls.image.SingleMultiDimensionImage

All Implemented Interfaces:

MultiDimensionImage

public class SingleMultiDimensionImage
extends java.lang.Object
implements MultiDimensionImage

Image who provides the same image for all dimensions

Since:

3.0

Property Summary

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

Constructor Summary

Constructors

Constructor and Description
SingleMultiDimensionImage(javafx.scene.image.Image img) Create a new image
SingleMultiDimensionImage(ThreadSynchronize threadSynchronize, javafx.scene.image.Image placeholder, O data, java.util.function.Function<O,javafx.scene.image.Image> imageComputer, <any> cache) Create a new image who is calculated in a background thread.

Method Summary

Modifier and Type	Method and Description
double	getRatio() Gets the value of the property ratio.
javafx.beans.property.ReadOnlyObjectProperty<javafx.scene.image.Image>	imageProperty()
javafx.beans.property.ReadOnlyDoubleProperty	ratioProperty()
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

See Also:

getRatio()

image

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

Specified by:

imageProperty in interface MultiDimensionImage

Constructor Detail

SingleMultiDimensionImage

public SingleMultiDimensionImage(javafx.scene.image.Image img)

Create a new image

Parameters:

img - the one and only image

SingleMultiDimensionImage

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

Create a new image who is calculated in a background thread. The provided domain object is used a lock monitor so that for one domain object no more than one calculation is running at a time

Parameters:

threadSynchronize - synchronize to ui thread

placeholder - image used as a placeholder presented while computing

data - the domain object the image is computed for

imageComputer - function to compute the 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

See Also:

getRatio()

imageProperty

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

Specified by:

imageProperty in interface MultiDimensionImage

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