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

Annotation Interface FileList

@Retention(RUNTIME) @Target(FIELD) @Documented public @interface FileList
Renders a user-editable list of file (or directory) pickers

The annotated field must be String[] or a List<String> with each entry holding one path

This is the list counterpart of File

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

The property value is the list of paths 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
    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
    directory
    Select directories instead of files
    String
    filterName
    A human-readable description for the types() filter such as "Images"
    boolean
    fullWidth
     
    String
    icon
     
    int
    maxEntries
    Maximum number of entries the user may add and 0 means unlimited
    String
    placeholder
     
    boolean
    placeholderTranslation
    Deprecated.
    OneConfig auto-translates placeholder values that are translation keys so pass the key directly
    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
    String[]
    types
    The file extensions to filter the dialog by such as {".png", ".jpg"}

  • 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

    • types

      String[] types
      The file extensions to filter the dialog by such as {".png", ".jpg"}

      Entries may be written as ".png" or "png" or "*.png" and they are all normalised to the *.ext form TinyFdApi expects

      Leave empty to allow any file

      Default:
      {}

    • filterName

      String filterName
      A human-readable description for the types() filter such as "Images"
      Default:
      ""

    • directory

      boolean directory
      Select directories instead of files

      When true the types() value is ignored

      Default:
      false

    • placeholder

      @TranslatedDefault("oneconfig.filepicker.placeholder") String placeholder
      Default:
      "oneconfig.filepicker.placeholder"

    • placeholderTranslation

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

    • 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