Record Class EditorButton

java.lang.Object
java.lang.Record
dev.boze.api.gui.editor.EditorButton
Record Components:
role - What kind of action it is; themes may style roles differently
enabled - Whether it can be pressed right now
public record EditorButton(String label, EditorButton.Role role, BooleanSupplier enabled, Runnable action) extends Record
A button in an editor.

  • Constructor Details

    • EditorButton

      public EditorButton(String label, EditorButton.Role role, BooleanSupplier enabled, Runnable action)
      Creates an instance of a EditorButton record class.
      Parameters:
      label - the value for the label record component
      role - the value for the role record component
      enabled - the value for the enabled record component
      action - the value for the action record component

    • EditorButton

      public EditorButton(String label, Runnable action)
      A secondary button that is always enabled.

    • EditorButton

      public EditorButton(String label, EditorButton.Role role, Runnable action)
      A button that is always enabled.

  • Method Details

    • isEnabled

      public boolean isEnabled()

    • press

      public void press()
      Runs the action if the button is enabled.

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

    • label

      public String label()
      Returns the value of the label record component.
      Returns:
      the value of the label record component

    • role

      public EditorButton.Role role()
      Returns the value of the role record component.
      Returns:
      the value of the role record component

    • enabled

      public BooleanSupplier enabled()
      Returns the value of the enabled record component.
      Returns:
      the value of the enabled record component

    • action

      public Runnable action()
      Returns the value of the action record component.
      Returns:
      the value of the action record component