Package com.iizix.prop

Class GBadge

java.lang.Object
com.iizix.prop.GBadge
All Implemented Interfaces:
Cloneable
public final class GBadge extends Object implements Cloneable
A badge holds a short text with a color and font size. Longer texts can be applied and will be shown with trailing ellipsis and will show a tooltip when the component is focused. This is typically used for error or warning messages.

The class immutable and its clone is therefore itself.

Author:
Christopher Mindus

  • Field Details Link icon

    • DEFAULT_FONT_SIZE Link icon

      public static final int DEFAULT_FONT_SIZE
      The default font size (16 px).
      See Also:

    • text Link icon

      public final KString text
      The KString holding the text.

    • color Link icon

      public final GBadge.Color color
      The color.

    • location Link icon

      public final GBadge.Location location
      The location.

    • fontSize Link icon

      public final int fontSize
      The font size in pixels (6-255), zero for default 16.

  • Constructor Details Link icon

    • GBadge Link icon

      public GBadge(String text)
      Creates a new red badge with default font size (16 pixels). The location is top-trailing.
      Parameters:
      text - The plain text string, i.e. not in HTML.
      Throws:
      NullPointerException - If text is null.

    • GBadge Link icon

      public GBadge(KString text)
      Creates a new red badge with default font size (16 pixels). The location is top-trailing.
      Parameters:
      text - The text.
      Throws:
      NullPointerException - If text is null.

    • GBadge Link icon

      public GBadge(KString text, GBadge.Color color)
      Creates a new badge with default font size. The location is top-trailing.
      Parameters:
      text - The text.
      color - The color, null for default red.
      Throws:
      NullPointerException - If text is null.

    • GBadge Link icon

      public GBadge(KString text, GBadge.Location location)
      Creates a new red badge with default font size (16 pixels).
      Parameters:
      text - The text.
      location - The location, null for default top-trailing.
      Throws:
      NullPointerException - If text is null.

    • GBadge Link icon

      public GBadge(KString text, GBadge.Color color, GBadge.Location location)
      Creates a new badge with default font size (16 pixels).
      Parameters:
      text - The text.
      color - The color, null for default red.
      location - The location, null for default top-trailing.
      Throws:
      NullPointerException - If text is null.

    • GBadge Link icon

      public GBadge(KString text, GBadge badge)
      Creates a new badge with a text and the settings from an old badge.
      Parameters:
      text - The text.
      badge - The badge to use all settings from, exception the text.
      Throws:
      NullPointerException - If text is null.

    • GBadge Link icon

      public GBadge(KString text, GBadge.Color color, GBadge.Location location, int fontSize)
      Creates a new badge.
      Parameters:
      text - The text.
      color - The color, null for default red.
      location - The location, null for default top-trailing.
      fontSize - The font size between 6 to 255 pixels, 0 for default (16).
      Throws:
      NullPointerException - If text is null.
      IllegalArgumentException - If fontSize is not 6 to 255 pixels.

  • Method Details Link icon

    • clone Link icon

      public GBadge clone()
      Clones the badge.
      Overrides:
      clone in class Object
      Returns:
      A cloned badge instance.

    • dispose Link icon

      public void dispose()
      Disposes of the badge when no longer needed. This method is required for KString text.

    • finalize Link icon

      protected void finalize() throws Throwable
      Called when the badge is being garbage collected.

      The KString will be disposed if not previously disposed of.

      Overrides:
      finalize in class Object
      Throws:
      Throwable

    • equals Link icon

      public boolean equals(Object o)
      Checks if two badge objects are equal.
      Overrides:
      equals in class Object

    • hashCode Link icon

      public int hashCode()
      Hash code.
      Overrides:
      hashCode in class Object
      Returns:
      Returns the hash code.

    • equalsOmitReferenceRefreshCheck Link icon

      public boolean equalsOmitReferenceRefreshCheck(GBadge badge)
      Checks for pure equality between two GBadge's, excluding reference refresh counter checking but including potential original source string.

      This method is used when comparing values for e.g. save file.

      Parameters:
      badge - Another GBadge, perhaps null.
      Returns:
      true if equal, false otherwise.

    • toString Link icon

      public String toString()
      Returns a string representation of this class instance and its values.
      Overrides:
      toString in class Object
      Returns:
      a string representation of this class instance.