Package org.polyfrost.oneconfig.api.config.v1.annotations

Annotation Interface ColorList

@Retention(RUNTIME) @Target(FIELD) @Documented public @interface ColorList
Renders a user-editable list of colors with each row opening the usual color picker

The annotated field must be int[] or a List<Integer> of packed ARGB values

java.awt.Color[] is also accepted

Chroma is not offered here because there is nowhere to store the per-entry chroma flag

Use a single Color option for that

This is the list counterpart of Color

Rows can be added and removed and dragged into a different order

The property value is the list of colors in display order

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    title
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    addText
    Label of the button that appends a new entry
    boolean
    addTextTranslation
    Deprecated.
    OneConfig auto-translates addText values that are translation keys so pass the key directly
    boolean
    alpha
    Whether the picker exposes an opacity control
    String
    category
     
    boolean
    categoryTranslation
    Deprecated.
    OneConfig auto-translates category values that are translation keys so pass the key directly
    String
    description
     
    boolean
    descriptionTranslation
    Deprecated.
    OneConfig auto-translates description values that are translation keys so pass the key directly
    boolean
    fullWidth
     
    String
    icon
     
    int
    maxEntries
    Maximum number of entries the user may add and 0 means unlimited
    boolean
    reorderable
    Allow the user to drag entries to reorder them
    String
    subcategory
     
    boolean
    subcategoryTranslation
    Deprecated.
    translation keys will be translated by default
    boolean
    titleTranslation
    Deprecated.
    OneConfig auto-translates title values that are translation keys so pass the key directly

  • Element Details

    • title

      String title

    • titleTranslation

      @Deprecated boolean titleTranslation
      Deprecated.
      OneConfig auto-translates title values that are translation keys so pass the key directly
      Default:
      false

    • description

      String description
      Default:
      ""

    • descriptionTranslation

      @Deprecated boolean descriptionTranslation
      Deprecated.
      OneConfig auto-translates description values that are translation keys so pass the key directly
      Default:
      false

    • icon

      String icon
      Default:
      ""

    • category

      String category
      Default:
      "General"

    • categoryTranslation

      @Deprecated boolean categoryTranslation
      Deprecated.
      OneConfig auto-translates category values that are translation keys so pass the key directly
      Default:
      false

    • subcategory

      String subcategory
      Default:
      "General"

    • subcategoryTranslation

      @Deprecated boolean subcategoryTranslation
      Deprecated.
      translation keys will be translated by default
      Default:
      false

    • alpha

      boolean alpha
      Whether the picker exposes an opacity control
      Default:
      true

    • maxEntries

      int maxEntries
      Maximum number of entries the user may add and 0 means unlimited
      Default:
      0

    • reorderable

      boolean reorderable
      Allow the user to drag entries to reorder them
      Default:
      true

    • addText

      String addText
      Label of the button that appends a new entry
      Default:
      "Add"

    • addTextTranslation

      @Deprecated boolean addTextTranslation
      Deprecated.
      OneConfig auto-translates addText values that are translation keys so pass the key directly
      Default:
      false

    • fullWidth

      boolean fullWidth
      Default:
      false