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

Class GlowBuilder

java.lang.Object
io.github.sosuisen.jfxbuilder.graphics.GlowBuilder
public class GlowBuilder extends Object
The GlowBuilder class constructs instances of the Glow 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 Glow constructor and returns an instance of the GlowBuilder.

You can use method chaining to call the builder methods for configuring the Glow. Finally, invoke the build method to generate an instance of the Glow 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 Details

    • create

      public static GlowBuilder create()
      Returns an instance of the GlowBuilder.
      Returns:
      an instance of the GlowBuilder.

    • create

      public static GlowBuilder create(double level)
      Accepts the constructor arguments of Glow(double) and returns an instance of GlowBuilder.
      Returns:
      an instance of the GlowBuilder.

    • build

      public Glow build()
      Builds and returns an instance of the Glow 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 Glow class

    • apply

      public GlowBuilder apply(Consumer<Glow> func)
      Applies a function to the Glow instance being constructed. Most operations on the instance can be performed using this method.
      Returns:
      builder instance

    • input

      public GlowBuilder input(Effect value)
      A builder method that invokes the setInput method on the instance being constructed.
      Returns:
      builder instance

    • level

      public GlowBuilder level(double value)
      A builder method that invokes the setLevel method on the instance being constructed.
      Returns:
      builder instance

    • inputPropertyApply

      public GlowBuilder inputPropertyApply(Consumer<ObjectProperty<Effect>> op)
      Applies a function to the inputProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

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

// Use shorthand form
.inputPropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance

    • levelPropertyApply

      public GlowBuilder levelPropertyApply(Consumer<DoubleProperty> op)
      Applies a function to the levelProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

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

// Use shorthand form
.levelPropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance