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

Package io.github.sosuisen.jfxbuilder.graphics

Class ColumnConstraintsBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.ColumnConstraintsBuilder

public class ColumnConstraintsBuilder
extends Object

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

You can use method chaining to call the builder methods for configuring the ColumnConstraints. Finally, invoke the build method to generate an instance of the ColumnConstraints 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
ColumnConstraintsBuilder	apply(Consumer<ColumnConstraints> func)	Applies a function to the ColumnConstraints instance being constructed.
ColumnConstraints	build()	Builds and returns an instance of the ColumnConstraints class.
static ColumnConstraintsBuilder	create()	Returns an instance of the ColumnConstraintsBuilder.
static ColumnConstraintsBuilder	create(double width)	Accepts the constructor arguments of ColumnConstraints(double) and returns an instance of ColumnConstraintsBuilder.
static ColumnConstraintsBuilder	create(double minWidth, double prefWidth, double maxWidth)	Accepts the constructor arguments of ColumnConstraints(double, double, double) and returns an instance of ColumnConstraintsBuilder.
static ColumnConstraintsBuilder	create(double minWidth, double prefWidth, double maxWidth, Priority hgrow, HPos halignment, boolean fillWidth)	Accepts the constructor arguments of ColumnConstraints(double, double, double, Priority, HPos, boolean) and returns an instance of ColumnConstraintsBuilder.
ColumnConstraintsBuilder	fillWidth(boolean value)	A builder method that invokes the setFillWidth method on the instance being constructed.
ColumnConstraintsBuilder	fillWidthPropertyApply(Consumer<BooleanProperty> op)	Applies a function to the fillWidthProperty of the instance being constructed.
ColumnConstraintsBuilder	halignment(HPos value)	A builder method that invokes the setHalignment method on the instance being constructed.
ColumnConstraintsBuilder	halignmentPropertyApply(Consumer<ObjectProperty<HPos>> op)	Applies a function to the halignmentProperty of the instance being constructed.
ColumnConstraintsBuilder	hgrow(Priority value)	A builder method that invokes the setHgrow method on the instance being constructed.
ColumnConstraintsBuilder	hgrowPropertyApply(Consumer<ObjectProperty<Priority>> op)	Applies a function to the hgrowProperty of the instance being constructed.
ColumnConstraintsBuilder	maxWidth(double value)	A builder method that invokes the setMaxWidth method on the instance being constructed.
ColumnConstraintsBuilder	maxWidthPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the maxWidthProperty of the instance being constructed.
ColumnConstraintsBuilder	minWidth(double value)	A builder method that invokes the setMinWidth method on the instance being constructed.
ColumnConstraintsBuilder	minWidthPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the minWidthProperty of the instance being constructed.
ColumnConstraintsBuilder	percentWidth(double value)	A builder method that invokes the setPercentWidth method on the instance being constructed.
ColumnConstraintsBuilder	percentWidthPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the percentWidthProperty of the instance being constructed.
ColumnConstraintsBuilder	prefWidth(double value)	A builder method that invokes the setPrefWidth method on the instance being constructed.
ColumnConstraintsBuilder	prefWidthPropertyApply(Consumer<DoubleProperty> op)	Applies a function to the prefWidthProperty 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 ColumnConstraintsBuilder create()

Returns an instance of the ColumnConstraintsBuilder.

Returns:

an instance of the ColumnConstraintsBuilder.

create

public static ColumnConstraintsBuilder create(double width)

Accepts the constructor arguments of ColumnConstraints(double) and returns an instance of ColumnConstraintsBuilder.

Returns:

an instance of the ColumnConstraintsBuilder.

create

public static ColumnConstraintsBuilder create(double minWidth,
 double prefWidth,
 double maxWidth)

Accepts the constructor arguments of ColumnConstraints(double, double, double) and returns an instance of ColumnConstraintsBuilder.

Returns:

an instance of the ColumnConstraintsBuilder.

create

public static ColumnConstraintsBuilder create(double minWidth,
 double prefWidth,
 double maxWidth,
 Priority hgrow,
 HPos halignment,
 boolean fillWidth)

Accepts the constructor arguments of ColumnConstraints(double, double, double, Priority, HPos, boolean) and returns an instance of ColumnConstraintsBuilder.

Returns:

an instance of the ColumnConstraintsBuilder.

build

public ColumnConstraints build()

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

apply

public ColumnConstraintsBuilder apply(Consumer<ColumnConstraints> func)

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

Returns:

builder instance

fillWidth

public ColumnConstraintsBuilder fillWidth(boolean value)

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

Returns:

builder instance

halignment

public ColumnConstraintsBuilder halignment(HPos value)

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

Returns:

builder instance

hgrow

public ColumnConstraintsBuilder hgrow(Priority value)

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

Returns:

builder instance

maxWidth

public ColumnConstraintsBuilder maxWidth(double value)

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

Returns:

builder instance

minWidth

public ColumnConstraintsBuilder minWidth(double value)

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

Returns:

builder instance

percentWidth

public ColumnConstraintsBuilder percentWidth(double value)

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

Returns:

builder instance

prefWidth

public ColumnConstraintsBuilder prefWidth(double value)

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

Returns:

builder instance

fillWidthPropertyApply

public ColumnConstraintsBuilder fillWidthPropertyApply(Consumer<BooleanProperty> op)

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

Example:

Returns:

builder instance

halignmentPropertyApply

public ColumnConstraintsBuilder halignmentPropertyApply(Consumer<ObjectProperty<HPos>> op)

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

Example:

Returns:

builder instance

hgrowPropertyApply

public ColumnConstraintsBuilder hgrowPropertyApply(Consumer<ObjectProperty<Priority>> op)

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

Example:

Returns:

builder instance

maxWidthPropertyApply

public ColumnConstraintsBuilder maxWidthPropertyApply(Consumer<DoubleProperty> op)

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

Example:

Returns:

builder instance

minWidthPropertyApply

public ColumnConstraintsBuilder minWidthPropertyApply(Consumer<DoubleProperty> op)

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

Example:

Returns:

builder instance

percentWidthPropertyApply

public ColumnConstraintsBuilder percentWidthPropertyApply(Consumer<DoubleProperty> op)

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

Example:

Returns:

builder instance

prefWidthPropertyApply

public ColumnConstraintsBuilder prefWidthPropertyApply(Consumer<DoubleProperty> op)

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

Example:

Returns:

builder instance