org.eclipse.fx.core.fxml

Class ImageBuilder

java.lang.Object

org.eclipse.fx.core.fxml.ImageBuilder

All Implemented Interfaces:

javafx.util.Builder<javafx.scene.image.Image>

public class ImageBuilder
extends java.lang.Object
implements javafx.util.Builder<javafx.scene.image.Image>

A builder for images

Constructor Summary

Constructors

Constructor and Description
ImageBuilder()

Method Summary

Modifier and Type	Method and Description
@NonNull ImageBuilder	backgroundLoading(boolean backgroundLoading) Load the image in background
@NonNull javafx.scene.image.Image	build()
static @NonNull ImageBuilder	create()
@NonNull ImageBuilder	preserveRatio(boolean preserveRatio) true to preserve the ratio
@NonNull ImageBuilder	requestedHeight(double requestedHeight) The requested height
@NonNull ImageBuilder	requestedWidth(double requestedWidth) The requested width
@NonNull ImageBuilder	smooth(boolean smooth) true to smooth the image when scaling
@NonNull ImageBuilder	url(@Nullable java.lang.String url) Add an url property

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageBuilder

public ImageBuilder()

Method Detail

create

public static @NonNull ImageBuilder create()

Returns:

a new builder instance

url

public @NonNull ImageBuilder url(@Nullable java.lang.String url)

Add an url property

Parameters:

url - the url

Returns:

the builder

See Also:

Image.Image(String, double, double, boolean, boolean, boolean)

requestedWidth

public @NonNull ImageBuilder requestedWidth(double requestedWidth)

The requested width

Parameters:

requestedWidth - the width

Returns:

the builder

See Also:

Image.Image(String, double, double, boolean, boolean, boolean)

requestedHeight

public @NonNull ImageBuilder requestedHeight(double requestedHeight)

The requested height

Parameters:

requestedHeight - the height

Returns:

the builder

See Also:

Image.Image(String, double, double, boolean, boolean, boolean)

preserveRatio

public @NonNull ImageBuilder preserveRatio(boolean preserveRatio)

true to preserve the ratio

Parameters:

preserveRatio - preserve the ratio

Returns:

the builder

smooth

public @NonNull ImageBuilder smooth(boolean smooth)

true to smooth the image when scaling

Parameters:

smooth - turn on/off smoothing

Returns:

the builder

backgroundLoading

public @NonNull ImageBuilder backgroundLoading(boolean backgroundLoading)

Load the image in background

Parameters:

backgroundLoading - turn on/off background loading

Returns:

the builder

build

public @NonNull javafx.scene.image.Image build()

Specified by:

build in interface javafx.util.Builder<javafx.scene.image.Image>