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

Package io.github.sosuisen.jfxbuilder.graphics

Class RowConstraintsBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.RowConstraintsBuilder

public class RowConstraintsBuilder
extends Object

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

You can use method chaining to call the builder methods for configuring the RowConstraints. Finally, invoke the build method to generate an instance of the RowConstraints 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
RowConstraintsBuilder	apply(Consumer<RowConstraints> func)	Applies a function to the RowConstraints instance being constructed.
RowConstraints	build()	Builds and returns an instance of the RowConstraints class.
static RowConstraintsBuilder	create()	Returns an instance of the RowConstraintsBuilder.
static RowConstraintsBuilder	create(double height)	Accepts the constructor arguments of RowConstraints(double) and returns an instance of RowConstraintsBuilder.
static RowConstraintsBuilder	create(double minHeight, double prefHeight, double maxHeight)	Accepts the constructor arguments of RowConstraints(double, double, double) and returns an instance of RowConstraintsBuilder.
static RowConstraintsBuilder	create(double minHeight, double prefHeight, double maxHeight, Priority vgrow, VPos valignment, boolean fillHeight)	Accepts the constructor arguments of RowConstraints(double, double, double, Priority, VPos, boolean) and returns an instance of RowConstraintsBuilder.
RowConstraintsBuilder	fillHeight(boolean value)	A builder method that invokes the setFillHeight method on the instance being constructed.
RowConstraintsBuilder	fillHeightPropertyApply(Consumer<BooleanProperty> op)	Applies a function to the fillHeightProperty of the instance being constructed.
RowConstraintsBuilder	maxHeight(double value)	A builder method that invokes the setMaxHeight method on the instance being constructed.
RowConstraintsBuilder	maxHeightPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the maxHeightProperty of the instance being constructed.
RowConstraintsBuilder	minHeight(double value)	A builder method that invokes the setMinHeight method on the instance being constructed.
RowConstraintsBuilder	minHeightPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the minHeightProperty of the instance being constructed.
RowConstraintsBuilder	percentHeight(double value)	A builder method that invokes the setPercentHeight method on the instance being constructed.
RowConstraintsBuilder	percentHeightPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the percentHeightProperty of the instance being constructed.
RowConstraintsBuilder	prefHeight(double value)	A builder method that invokes the setPrefHeight method on the instance being constructed.
RowConstraintsBuilder	prefHeightPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the prefHeightProperty of the instance being constructed.
RowConstraintsBuilder	valignment(VPos value)	A builder method that invokes the setValignment method on the instance being constructed.
RowConstraintsBuilder	valignmentPropertyApply(Consumer<ObjectProperty<VPos>> op)	Applies a function to the valignmentProperty of the instance being constructed.
RowConstraintsBuilder	vgrow(Priority value)	A builder method that invokes the setVgrow method on the instance being constructed.
RowConstraintsBuilder	vgrowPropertyApply(Consumer<ObjectProperty<Priority>> op)	Applies a function to the vgrowProperty 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 RowConstraintsBuilder create()

Returns an instance of the RowConstraintsBuilder.

Returns:

an instance of the RowConstraintsBuilder.

create

public static RowConstraintsBuilder create(double height)

Accepts the constructor arguments of RowConstraints(double) and returns an instance of RowConstraintsBuilder.

Returns:

an instance of the RowConstraintsBuilder.

create

public static RowConstraintsBuilder create(double minHeight,
 double prefHeight,
 double maxHeight)

Accepts the constructor arguments of RowConstraints(double, double, double) and returns an instance of RowConstraintsBuilder.

Returns:

an instance of the RowConstraintsBuilder.

create

public static RowConstraintsBuilder create(double minHeight,
 double prefHeight,
 double maxHeight,
 Priority vgrow,
 VPos valignment,
 boolean fillHeight)

Accepts the constructor arguments of RowConstraints(double, double, double, Priority, VPos, boolean) and returns an instance of RowConstraintsBuilder.

Returns:

an instance of the RowConstraintsBuilder.

build

public RowConstraints build()

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

apply

public RowConstraintsBuilder apply(Consumer<RowConstraints> func)

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

Returns:

builder instance

fillHeight

public RowConstraintsBuilder fillHeight(boolean value)

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

Returns:

builder instance

maxHeight

public RowConstraintsBuilder maxHeight(double value)

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

Returns:

builder instance

minHeight

public RowConstraintsBuilder minHeight(double value)

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

Returns:

builder instance

percentHeight

public RowConstraintsBuilder percentHeight(double value)

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

Returns:

builder instance

prefHeight

public RowConstraintsBuilder prefHeight(double value)

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

Returns:

builder instance

valignment

public RowConstraintsBuilder valignment(VPos value)

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

Returns:

builder instance

vgrow

public RowConstraintsBuilder vgrow(Priority value)

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

Returns:

builder instance

fillHeightPropertyApply

public RowConstraintsBuilder fillHeightPropertyApply(Consumer<BooleanProperty> op)

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

Example:

Returns:

builder instance

maxHeightPropertyApply

public RowConstraintsBuilder maxHeightPropertyApply(Consumer<DoubleProperty> op)

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

Example:

Returns:

builder instance

minHeightPropertyApply

public RowConstraintsBuilder minHeightPropertyApply(Consumer<DoubleProperty> op)

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

Example:

Returns:

builder instance

percentHeightPropertyApply

public RowConstraintsBuilder percentHeightPropertyApply(Consumer<DoubleProperty> op)

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

Example:

Returns:

builder instance

prefHeightPropertyApply

public RowConstraintsBuilder prefHeightPropertyApply(Consumer<DoubleProperty> op)

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

Example:

Returns:

builder instance

valignmentPropertyApply

public RowConstraintsBuilder valignmentPropertyApply(Consumer<ObjectProperty<VPos>> op)

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

Example:

Returns:

builder instance

vgrowPropertyApply

public RowConstraintsBuilder vgrowPropertyApply(Consumer<ObjectProperty<Priority>> op)

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

Example:

Returns:

builder instance