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

Package io.github.sosuisen.jfxbuilder.graphics

Class BorderImageBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.BorderImageBuilder

public class BorderImageBuilder
extends Object

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

You can use method chaining to call the builder methods for configuring the BorderImage. Finally, invoke the build method to generate an instance of the BorderImage 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
BorderImageBuilder	apply(Consumer<BorderImage> func)	Applies a function to the BorderImage instance being constructed.
BorderImage	build()	Builds and returns an instance of the BorderImage class.
static BorderImageBuilder	create(Image image, BorderWidths widths, Insets insets, BorderWidths slices, boolean filled, BorderRepeat repeatX, BorderRepeat repeatY)	Accepts the constructor arguments of BorderImage(Image, BorderWidths, Insets, BorderWidths, boolean, BorderRepeat, BorderRepeat) and returns an instance of BorderImageBuilder.

Methods inherited from class java.lang.Object

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

Method Details

create

public static BorderImageBuilder create(Image image,
 BorderWidths widths,
 Insets insets,
 BorderWidths slices,
 boolean filled,
 BorderRepeat repeatX,
 BorderRepeat repeatY)

Accepts the constructor arguments of BorderImage(Image, BorderWidths, Insets, BorderWidths, boolean, BorderRepeat, BorderRepeat) and returns an instance of BorderImageBuilder.

Returns:

an instance of the BorderImageBuilder.

build

public BorderImage build()

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

apply

public BorderImageBuilder apply(Consumer<BorderImage> func)

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

Returns:

builder instance