Module technology.sola.engine
Package technology.sola.engine.graphics.gui.style

Record Class ConditionalStyle<Style extends BaseStyles>

java.lang.Object
java.lang.Record
technology.sola.engine.graphics.gui.style.ConditionalStyle<Style>
Type Parameters:
Style - the style type
Record Components:
condition - the condition for when the style should be applied
style - the style instance
@NullMarked public record ConditionalStyle<Style extends BaseStyles>(Function<GuiElement<Style extends BaseStyles,?>,Boolean> condition, Style extends BaseStyles style) extends Record
ConditionalStyle holds a BaseStyles instance and a condition for when it should be applied.

  • Constructor Details

    • ConditionalStyle

      public ConditionalStyle(Function<GuiElement<Style,?>,Boolean> condition, Style style)
      Creates an instance of a ConditionalStyle record class.
      Parameters:
      condition - the value for the condition record component
      style - the value for the style record component

  • Method Details

    • always

      public static <Style extends BaseStyles> ConditionalStyle<Style> always(Style style)
      Creates a ConditionalStyle instance for a style that will always be applied.
      Type Parameters:
      Style - the style type
      Parameters:
      style - the style to apply
      Returns:
      a ConditionalStyle instance

    • active

      public static <Style extends BaseStyles> ConditionalStyle<Style> active(Style style)
      Creates a ConditionalStyle instance for a style that will be applied when the GuiElement is active.
      Type Parameters:
      Style - the style type
      Parameters:
      style - the style to apply
      Returns:
      a ConditionalStyle instance

    • hover

      public static <Style extends BaseStyles> ConditionalStyle<Style> hover(Style style)
      Creates a ConditionalStyle instance for a style that will be applied when the GuiElement is hovered.
      Type Parameters:
      Style - the style type
      Parameters:
      style - the style to apply
      Returns:
      a ConditionalStyle instance

    • focus

      public static <Style extends BaseStyles> ConditionalStyle<Style> focus(Style style)
      Creates a ConditionalStyle instance for a style that will be applied when the GuiElement is focussed.
      Type Parameters:
      Style - the style type
      Parameters:
      style - the style to apply
      Returns:
      a ConditionalStyle instance

    • disabled

      public static <Style extends BaseStyles> ConditionalStyle<Style> disabled(Style style)
      Creates a ConditionalStyle instance for a style that will be applied when the GuiElement is disabled. This can only apply to elements that extend BaseInputGuiElement.
      Type Parameters:
      Style - the style type
      Parameters:
      style - the style to apply
      Returns:
      a ConditionalStyle instance

    • isActiveStyle

      public boolean isActiveStyle()
      Returns:
      true if the condition of this style is GuiElement.isActive()

    • isHoverStyle

      public boolean isHoverStyle()
      Returns:
      true if the condition of this style is GuiElement.isHovered()

    • 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.

    • condition

      public Function<GuiElement<Style,?>,Boolean> condition()
      Returns the value of the condition record component.
      Returns:
      the value of the condition record component

    • style

      public Style style()
      Returns the value of the style record component.
      Returns:
      the value of the style record component