Module io.github.sosuisen.api.jfxbuilder.graphics

Package io.github.sosuisen.jfxbuilder.graphics

Class InnerShadowBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.InnerShadowBuilder

public class InnerShadowBuilder
extends Object

The InnerShadowBuilder class constructs instances of the InnerShadow 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 InnerShadow constructor and returns an instance of the InnerShadowBuilder.

You can use method chaining to call the builder methods for configuring the InnerShadow. Finally, invoke the build method to generate an instance of the InnerShadow 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
InnerShadowBuilder	apply(Consumer<InnerShadow> func)	Applies a function to the InnerShadow instance being constructed.
InnerShadowBuilder	blurType(BlurType value)	A builder method that invokes the setBlurType method on the instance being constructed.
InnerShadowBuilder	blurTypePropertyApply(Consumer<ObjectProperty<BlurType>> op)	Applies a function to the blurTypeProperty of the instance being constructed.
InnerShadow	build()	Builds and returns an instance of the InnerShadow class.
InnerShadowBuilder	choke(double value)	A builder method that invokes the setChoke method on the instance being constructed.
InnerShadowBuilder	chokePropertyApply(Consumer<DoubleProperty> op)	Applies a function to the chokeProperty of the instance being constructed.
InnerShadowBuilder	color(Color value)	A builder method that invokes the setColor method on the instance being constructed.
InnerShadowBuilder	colorPropertyApply(Consumer<ObjectProperty<Color>> op)	Applies a function to the colorProperty of the instance being constructed.
static InnerShadowBuilder	create()	Returns an instance of the InnerShadowBuilder.
static InnerShadowBuilder	create(double radius, double offsetX, double offsetY, Color color)	Accepts the constructor arguments of InnerShadow(double, double, double, Color) and returns an instance of InnerShadowBuilder.
static InnerShadowBuilder	create(double radius, Color color)	Accepts the constructor arguments of InnerShadow(double, Color) and returns an instance of InnerShadowBuilder.
static InnerShadowBuilder	create(BlurType blurType, Color color, double radius, double choke, double offsetX, double offsetY)	Accepts the constructor arguments of InnerShadow(BlurType, Color, double, double, double, double) and returns an instance of InnerShadowBuilder.
InnerShadowBuilder	height(double value)	A builder method that invokes the setHeight method on the instance being constructed.
InnerShadowBuilder	heightPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the heightProperty of the instance being constructed.
InnerShadowBuilder	input(Effect value)	A builder method that invokes the setInput method on the instance being constructed.
InnerShadowBuilder	inputPropertyApply(Consumer<ObjectProperty<Effect>> op)	Applies a function to the inputProperty of the instance being constructed.
InnerShadowBuilder	offsetX(double value)	A builder method that invokes the setOffsetX method on the instance being constructed.
InnerShadowBuilder	offsetXPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the offsetXProperty of the instance being constructed.
InnerShadowBuilder	offsetY(double value)	A builder method that invokes the setOffsetY method on the instance being constructed.
InnerShadowBuilder	offsetYPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the offsetYProperty of the instance being constructed.
InnerShadowBuilder	radius(double value)	A builder method that invokes the setRadius method on the instance being constructed.
InnerShadowBuilder	radiusPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the radiusProperty of the instance being constructed.
InnerShadowBuilder	width(double value)	A builder method that invokes the setWidth method on the instance being constructed.
InnerShadowBuilder	widthPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the widthProperty of the instance being constructed.

Methods inherited from class java.lang.Object

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

Method Details

create

public static InnerShadowBuilder create()

Returns an instance of the InnerShadowBuilder.

Returns:

an instance of the InnerShadowBuilder.

create

public static InnerShadowBuilder create(double radius,
 double offsetX,
 double offsetY,
 Color color)

Accepts the constructor arguments of InnerShadow(double, double, double, Color) and returns an instance of InnerShadowBuilder.

Returns:

an instance of the InnerShadowBuilder.

create

public static InnerShadowBuilder create(double radius,
 Color color)

Accepts the constructor arguments of InnerShadow(double, Color) and returns an instance of InnerShadowBuilder.

Returns:

an instance of the InnerShadowBuilder.

create

public static InnerShadowBuilder create(BlurType blurType,
 Color color,
 double radius,
 double choke,
 double offsetX,
 double offsetY)

Accepts the constructor arguments of InnerShadow(BlurType, Color, double, double, double, double) and returns an instance of InnerShadowBuilder.

Returns:

an instance of the InnerShadowBuilder.

build

public InnerShadow build()

Builds and returns an instance of the InnerShadow 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 InnerShadow class

apply

public InnerShadowBuilder apply(Consumer<InnerShadow> func)

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

Returns:

builder instance

blurType

public InnerShadowBuilder blurType(BlurType value)

A builder method that invokes the setBlurType method on the instance being constructed.

Returns:

builder instance

choke

public InnerShadowBuilder choke(double value)

A builder method that invokes the setChoke method on the instance being constructed.

Returns:

builder instance

color

public InnerShadowBuilder color(Color value)

A builder method that invokes the setColor method on the instance being constructed.

Returns:

builder instance

height

public InnerShadowBuilder height(double value)

A builder method that invokes the setHeight method on the instance being constructed.

Returns:

builder instance

input

public InnerShadowBuilder input(Effect value)

A builder method that invokes the setInput method on the instance being constructed.

Returns:

builder instance

offsetX

public InnerShadowBuilder offsetX(double value)

A builder method that invokes the setOffsetX method on the instance being constructed.

Returns:

builder instance

offsetY

public InnerShadowBuilder offsetY(double value)

A builder method that invokes the setOffsetY method on the instance being constructed.

Returns:

builder instance

radius

public InnerShadowBuilder radius(double value)

A builder method that invokes the setRadius method on the instance being constructed.

Returns:

builder instance

width

public InnerShadowBuilder width(double value)

A builder method that invokes the setWidth method on the instance being constructed.

Returns:

builder instance

blurTypePropertyApply

public InnerShadowBuilder blurTypePropertyApply(Consumer<ObjectProperty<BlurType>> op)

Applies a function to the blurTypeProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

Returns:

builder instance

chokePropertyApply

public InnerShadowBuilder chokePropertyApply(Consumer<DoubleProperty> op)

Applies a function to the chokeProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

Returns:

builder instance

colorPropertyApply

public InnerShadowBuilder colorPropertyApply(Consumer<ObjectProperty<Color>> op)

Applies a function to the colorProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

Returns:

builder instance

heightPropertyApply

public InnerShadowBuilder heightPropertyApply(Consumer<DoubleProperty> op)

Applies a function to the heightProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

Returns:

builder instance

inputPropertyApply

public InnerShadowBuilder inputPropertyApply(Consumer<ObjectProperty<Effect>> op)

Applies a function to the inputProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

Returns:

builder instance

offsetXPropertyApply

public InnerShadowBuilder offsetXPropertyApply(Consumer<DoubleProperty> op)

Applies a function to the offsetXProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

Returns:

builder instance

offsetYPropertyApply

public InnerShadowBuilder offsetYPropertyApply(Consumer<DoubleProperty> op)

Applies a function to the offsetYProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

Returns:

builder instance

radiusPropertyApply

public InnerShadowBuilder radiusPropertyApply(Consumer<DoubleProperty> op)

Applies a function to the radiusProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

Returns:

builder instance

widthPropertyApply

public InnerShadowBuilder widthPropertyApply(Consumer<DoubleProperty> op)

Applies a function to the widthProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

Returns:

builder instance