Class TextFieldSkinBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.controls.TextFieldSkinBuilder

public class TextFieldSkinBuilder
extends Object

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

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

Accepts the constructor arguments of TextFieldSkin(TextField) and returns an instance of TextFieldSkinBuilder.

Returns:

an instance of the TextFieldSkinBuilder.

build

public TextFieldSkin build()

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

apply

public TextFieldSkinBuilder apply(Consumer<TextFieldSkin> func)

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

Returns:

builder instance

caretAnimating

public TextFieldSkinBuilder caretAnimating(boolean value)

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

Returns:

builder instance

forwardBias

public TextFieldSkinBuilder forwardBias(boolean isLeading)

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

Returns:

builder instance

addChildren

public final TextFieldSkinBuilder addChildren(Node... elements)

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

Returns:

builder instance

addChildren

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

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

Returns:

builder instance