Package limn.accessibility

Record Class ToggleFacet

java.lang.Object
java.lang.Record
limn.accessibility.ToggleFacet
Record Components:
state - whether the node is off, on, or neither
public record ToggleFacet(ToggleFacet.State state) extends Record
A node that carries a checked state: a checkbox, a switch, a check menu item, a toggle button.

It is a facet rather than a flag because checked-ness has three homes across the three platforms — a pattern object on one, a state bit plus an action row on another, a value attribute on the third — and each of those views is derived from this one record.

  • Constructor Details

    • ToggleFacet

      public ToggleFacet(ToggleFacet.State state)
      Creates an instance of a ToggleFacet record class.
      Parameters:
      state - the value for the state record component

  • Method Details

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

    • state

      public ToggleFacet.State state()
      Returns the value of the state record component.
      Returns:
      the value of the state record component