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

Annotation Interface NumberList

@Retention(RUNTIME) @Target(FIELD) @Documented public @interface NumberList
Renders a user-editable list of numbers with each row being a number input with stepper arrows

The annotated field must be a numeric array such as int[] or float[] or double[] or long[] or a List of numbers

Entries are stored in the element type of the field

For list fields the type is taken from the entries already present and falls back to Integer when min()/max()/step() are whole numbers

This is the list counterpart of Number

See SliderList for the slider variant

  • 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
    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
    Class<? extends ValueFormatter>
    formatter
     
    boolean
    fullWidth
     
    String
    icon
     
    float
    max
     
    int
    maxEntries
    Maximum number of entries the user may add and 0 means unlimited
    float
    min
     
    boolean
    reorderable
    Allow the user to drag entries to reorder them
    float
    step
    Amount each press of the stepper arrows changes the entry by and 0 picks a sensible default
    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

    • min

      float min
      Default:
      0.0f

    • max

      float max
      Default:
      100.0f

    • step

      float step
      Amount each press of the stepper arrows changes the entry by and 0 picks a sensible default
      Default:
      0.0f

    • 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

    • formatter

      Class<? extends ValueFormatter> formatter
      Default:
      org.polyfrost.oneconfig.api.config.v1.ValueFormatter.class

    • fullWidth

      boolean fullWidth
      Default:
      false