Class TextAreaSkinBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.controls.TextAreaSkinBuilder

public class TextAreaSkinBuilder
extends Object

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

You can use method chaining to call the builder methods for configuring the TextAreaSkin. Finally, invoke the build method to generate an instance of the TextAreaSkin 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
final TextAreaSkinBuilder	addChildren(Collection<? extends Node> col)	Calls the addAll method on the ObservableList returned by the TextAreaSkin#getChildren() method.
final TextAreaSkinBuilder	addChildren(Node... elements)	Calls the addAll method on the ObservableList returned by the TextAreaSkin#getChildren() method.
TextAreaSkinBuilder	apply(Consumer<TextAreaSkin> func)	Applies a function to the TextAreaSkin instance being constructed.
TextAreaSkin	build()	Builds and returns an instance of the TextAreaSkin class.
TextAreaSkinBuilder	caretAnimating(boolean value)	A builder method that invokes the setCaretAnimating method on the instance being constructed.
static TextAreaSkinBuilder	create(TextArea control)	Accepts the constructor arguments of TextAreaSkin(TextArea) and returns an instance of TextAreaSkinBuilder.
TextAreaSkinBuilder	forwardBias(boolean isLeading)	A builder method that invokes the setForwardBias method on the instance being constructed.

Methods inherited from class Object

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

Method Details

create

public static TextAreaSkinBuilder create(TextArea control)

Accepts the constructor arguments of TextAreaSkin(TextArea) and returns an instance of TextAreaSkinBuilder.

Returns:

an instance of the TextAreaSkinBuilder.

build

public TextAreaSkin build()

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

apply

public TextAreaSkinBuilder apply(Consumer<TextAreaSkin> func)

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

Returns:

builder instance

caretAnimating

public TextAreaSkinBuilder caretAnimating(boolean value)

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

Returns:

builder instance

forwardBias

public TextAreaSkinBuilder forwardBias(boolean isLeading)

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

Returns:

builder instance

addChildren

public final TextAreaSkinBuilder addChildren(Node... elements)

Calls the addAll method on the ObservableList returned by the TextAreaSkin#getChildren() method.

Returns:

builder instance

addChildren

public final TextAreaSkinBuilder addChildren(Collection<? extends Node> col)

Calls the addAll method on the ObservableList returned by the TextAreaSkin#getChildren() method.

Returns:

builder instance