Class RadialGradientBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.RadialGradientBuilder

public class RadialGradientBuilder
extends Object

The RadialGradientBuilder class constructs instances of the RadialGradient class and offers a fluent interface for creating and configuring it.

This class includes a static create method that accepts the same arguments as the original RadialGradient constructor and returns an instance of the RadialGradientBuilder.

You can use method chaining to call the builder methods for configuring the RadialGradient. Finally, invoke the build method to generate an instance of the RadialGradient class.

Note that intermediate builder methods are not evaluated until the build method is called, meaning they are evaluated lazily.

Author:

Hidekazu Kubota <hidekazu.kubota@gmail.com>

Method Summary

Modifier and Type	Method	Description
RadialGradientBuilder	apply(Consumer<RadialGradient> func)	Applies a function to the RadialGradient instance being constructed.
RadialGradient	build()	Builds and returns an instance of the RadialGradient class.
static RadialGradientBuilder	create(double focusAngle, double focusDistance, double centerX, double centerY, double radius, boolean proportional, CycleMethod cycleMethod, List<Stop> stops)	Accepts the constructor arguments of RadialGradient(double, double, double, double, double, boolean, CycleMethod, List) and returns an instance of RadialGradientBuilder.
static RadialGradientBuilder	create(double focusAngle, double focusDistance, double centerX, double centerY, double radius, boolean proportional, CycleMethod cycleMethod, Stop... stops)	Accepts the constructor arguments of RadialGradient(double, double, double, double, double, boolean, CycleMethod, Stop...) and returns an instance of RadialGradientBuilder.

Methods inherited from class java.lang.Object

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

Method Details

create

public static RadialGradientBuilder create(double focusAngle,
 double focusDistance,
 double centerX,
 double centerY,
 double radius,
 boolean proportional,
 CycleMethod cycleMethod,
 List<Stop> stops)

Accepts the constructor arguments of RadialGradient(double, double, double, double, double, boolean, CycleMethod, List) and returns an instance of RadialGradientBuilder.

Returns:

an instance of the RadialGradientBuilder.

create

public static RadialGradientBuilder create(double focusAngle,
 double focusDistance,
 double centerX,
 double centerY,
 double radius,
 boolean proportional,
 CycleMethod cycleMethod,
 Stop... stops)

Accepts the constructor arguments of RadialGradient(double, double, double, double, double, boolean, CycleMethod, Stop...) and returns an instance of RadialGradientBuilder.

Returns:

an instance of the RadialGradientBuilder.

build

public RadialGradient build()

Builds and returns an instance of the RadialGradient class.

Intermediate builder methods are not evaluated until the build method is called; in other words, they are evaluated lazily.

Returns:

new instance of the RadialGradient class

apply

public RadialGradientBuilder apply(Consumer<RadialGradient> func)

Applies a function to the RadialGradient instance being constructed. Most operations on the instance can be performed using this method.

Returns:

builder instance