Record Class ColorRoles.ContrastPair

java.lang.Object
java.lang.Record
com.iizix.prop.ColorRoles.ContrastPair
Record Components:
foreground - The foreground role: text, or a mark such as a border.
background - The background role it is drawn on.
threshold - The ratio needed: ColorContrast.AA_TEXT for text, ColorContrast.AA_NON_TEXT for marks.
Enclosing class:
ColorRoles
public static record ColorRoles.ContrastPair(ColorRoles.Role foreground, ColorRoles.Role background, double threshold) extends Record
A pair of roles whose contrast a theme is checked for: a foreground drawn on a background, and the WCAG 2.x ratio it needs.
Author:
Christopher Mindus

  • Constructor Details

    • ContrastPair

      public ContrastPair(ColorRoles.Role foreground, ColorRoles.Role background, double threshold)
      Creates an instance of a ContrastPair record class.
      Parameters:
      foreground - the value for the foreground record component
      background - the value for the background record component
      threshold - the value for the threshold record component

  • Method Details

    • isText

      public boolean isText()
      Checks if the pair is a text pair rather than a mark.
      Returns:
      true when the threshold is the text one.

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • foreground

      public ColorRoles.Role foreground()
      Returns the value of the foreground record component.
      Returns:
      the value of the foreground record component

    • background

      public ColorRoles.Role background()
      Returns the value of the background record component.
      Returns:
      the value of the background record component

    • threshold

      public double threshold()
      Returns the value of the threshold record component.
      Returns:
      the value of the threshold record component