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

Class DragboardBuilder

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

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

    • build

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

    • apply

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

    • content

      public DragboardBuilder content(Map<DataFormat,Object> content)
      A builder method that invokes the setContent method on the instance being constructed.
      Returns:
      builder instance

    • dragView

      public DragboardBuilder dragView(Image image)
      A builder method that invokes the setDragView method on the instance being constructed.
      Returns:
      builder instance

    • dragView

      public DragboardBuilder dragView(Image image, double offsetX, double offsetY)
      A builder method that invokes the setDragView method on the instance being constructed.
      Returns:
      builder instance

    • dragViewOffsetX

      public DragboardBuilder dragViewOffsetX(double offsetX)
      A builder method that invokes the setDragViewOffsetX method on the instance being constructed.
      Returns:
      builder instance

    • dragViewOffsetY

      public DragboardBuilder dragViewOffsetY(double offsetY)
      A builder method that invokes the setDragViewOffsetY method on the instance being constructed.
      Returns:
      builder instance