Annotation Type EditorList.EdOptsList
-
@Retention(RUNTIME) @Target(FIELD) @Repeatable(EdOptsListList.class) public static @interface EditorList.EdOptsList
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description Class<? extends ConfigEditor>editorThe class to use as editor for the items in the list.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description StringeditorKeyThe key of the configuration for the nested ListEditor.booleanhorizontalFlag indicating the editor should be laid out horizontally.StringlabelTextThe text to display next to the "add" button.intmaxCountThe maximum number of items the list must have.intminCountThe minimum number of items the list must have.StringmyKeyThe key of the configuration for this ListEditor.StringprofilesEditA comma separated, case insensitive list of profile names.
-
-
-
Element Detail
-
editor
Class<? extends ConfigEditor> editor
The class to use as editor for the items in the list. The editor should also supply an annotation type to use for defining further parameters. An annotation of this type should also be set on the field. This means you can not nest lists, since that would result in two EdListOpts annotations on the same field.- Returns:
- The class to use as editor for the list items.
-
-
-
editorKey
String editorKey
The key of the configuration for the nested ListEditor. This needs to be set if you want to have a nested List inside another List. Since you need multiple EdOptsList annotations on the field in this case. The editorKey of the parent list must match the myKey of the child list.- Returns:
- The key of the configuration for the nested ListEditor.
- Default:
- "list-2"
-
-
-
myKey
String myKey
The key of the configuration for this ListEditor. This needs to be set if you want to have a nested List inside another List. Since you need multiple EdOptsList annotations on the field in this case. The editorKey of the parent list must match the myKey of the child list.- Returns:
- The key of the configuration for this ListEditor.
- Default:
- "list-1"
-
-
-
maxCount
int maxCount
The maximum number of items the list must have. Once the list has this many items, the user can not add more items to the list. If a configuration is loaded with more items, only this many items are loaded, the rest is ignored.- Returns:
- The maximum number of items the list may have.
- Default:
- 2147483647
-
-
-
labelText
String labelText
The text to display next to the "add" button.- Returns:
- The text to display next to the "add" button.
- Default:
- ""
-
-
-
profilesEdit
String profilesEdit
A comma separated, case insensitive list of profile names. This field is only editable when one of these profiles is active. The "default" profile is automatically added to the list.- Returns:
- A comma separated, case insensitive list of profile names.
- Default:
- ""
-
-