Record Class FrameBuilderWidget

java.lang.Object
java.lang.Record
dev.pfaff.altargui.widgets.FrameBuilderWidget
All Implemented Interfaces:
Widget

public record FrameBuilderWidget(FrameBuilderWidget.Builder builder) extends Record implements Widget
A widget that calls the provided builder once per frame. This is the preferred way to create widgets that animate or for which diffing would be too frequent and expensive.

The supplier is tracked. It is called again every frame.

  • Constructor Details

    • FrameBuilderWidget

      public FrameBuilderWidget(FrameBuilderWidget.Builder builder)
      Creates an instance of a FrameBuilderWidget record class.
      Parameters:
      builder - the value for the builder record component
  • Method Details

    • instantiate

      @NotNull public @NotNull WidgetInstance instantiate(WidgetInstantiationArgs args)
      Description copied from interface: Widget
      Instantiates an instance of the widget.
      Specified by:
      instantiate in interface Widget
    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • builder

      public FrameBuilderWidget.Builder builder()
      Returns the value of the builder record component.
      Returns:
      the value of the builder record component