Class ToggleGroupBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.controls.ToggleGroupBuilder

public class ToggleGroupBuilder
extends Object

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

You can use method chaining to call the builder methods for configuring the ToggleGroup. Finally, invoke the build method to generate an instance of the ToggleGroup 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 ToggleGroupBuilder	addToggles(Collection<? extends Toggle> col)	Calls the addAll method on the ObservableList returned by the ToggleGroup#getToggles() method.
final ToggleGroupBuilder	addToggles(Toggle... elements)	Calls the addAll method on the ObservableList returned by the ToggleGroup#getToggles() method.
ToggleGroupBuilder	apply(Consumer<ToggleGroup> func)	Applies a function to the ToggleGroup instance being constructed.
ToggleGroup	build()	Builds and returns an instance of the ToggleGroup class.
static ToggleGroupBuilder	create()	Returns an instance of the ToggleGroupBuilder.
ToggleGroupBuilder	selectedTogglePropertyApply(Consumer<ReadOnlyObjectProperty<Toggle>> op)	Applies a function to the selectedToggleProperty of the instance being constructed.
ToggleGroupBuilder	userData(Object value)	A builder method that invokes the setUserData method on the instance being constructed.
static ToggleGroupBuilder	withToggles(Collection<? extends Toggle> col)	Creates an instance of the builder, then calls the addAll method on the ObservableList returned by the ToggleGroup#getToggles() method.
static ToggleGroupBuilder	withToggles(Toggle... elements)	Creates an instance of the builder, then calls the addAll method on the ObservableList returned by the ToggleGroup#getToggles() method.

Methods inherited from class Object

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

Method Details

create

public static ToggleGroupBuilder create()

Returns an instance of the ToggleGroupBuilder.

Returns:

an instance of the ToggleGroupBuilder.

build

public ToggleGroup build()

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

apply

public ToggleGroupBuilder apply(Consumer<ToggleGroup> func)

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

Returns:

builder instance

userData

public ToggleGroupBuilder userData(Object value)

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

Returns:

builder instance

addToggles

public final ToggleGroupBuilder addToggles(Toggle... elements)

Calls the addAll method on the ObservableList returned by the ToggleGroup#getToggles() method.

Returns:

builder instance

addToggles

public final ToggleGroupBuilder addToggles(Collection<? extends Toggle> col)

Calls the addAll method on the ObservableList returned by the ToggleGroup#getToggles() method.

Returns:

builder instance

withToggles

public static ToggleGroupBuilder withToggles(Toggle... elements)

Creates an instance of the builder, then calls the addAll method on the ObservableList returned by the ToggleGroup#getToggles() method.

Returns:

builder instance

withToggles

public static ToggleGroupBuilder withToggles(Collection<? extends Toggle> col)

Creates an instance of the builder, then calls the addAll method on the ObservableList returned by the ToggleGroup#getToggles() method.

Returns:

builder instance

selectedTogglePropertyApply

public ToggleGroupBuilder selectedTogglePropertyApply(Consumer<ReadOnlyObjectProperty<Toggle>> op)

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

Example:

// Use apply
.apply(obj -> obj.selectedToggleProperty().bind(anotherProperty))

// Use shorthand form
.selectedTogglePropertyApply(prop -> prop.bind(anotherProperty))

Returns:

builder instance