Record Class MarqueeWidget

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

public record MarqueeWidget(Widget content, Duration cycleDuration) extends Record implements Widget
Inspired by the HTML marquee element. In contrast to that element, however, this element will loop the element while it is still exiting the screen.

As a result of this, if the widget has managed state, there will be two independent copies of the state.

  • Constructor Details

    • MarqueeWidget

      public MarqueeWidget(Widget content, Duration cycleDuration)
      Creates an instance of a MarqueeWidget record class.
      Parameters:
      content - the value for the content record component
      cycleDuration - the value for the cycleDuration record component
  • Method Details

    • instantiate

      public @NonNull WidgetInstance<MarqueeWidget> 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.
    • content

      public Widget content()
      Returns the value of the content record component.
      Returns:
      the value of the content record component
    • cycleDuration

      public Duration cycleDuration()
      Returns the value of the cycleDuration record component.
      Returns:
      the value of the cycleDuration record component