Static List allows to store and display single-select or multi-select fields that can be displayed as select, checkbox, radio or suggests fields.

Properties

We list in the following the properties of Static List and their meanings.

Display Type

Several types are available for displaying a static list:

  • select: display the list as an html select
  • checkbox: display the list as checkboxes
  • radio: display the list as a radio button
  • input: display a simple input text. Note that this option might be used in combination with Use suggest and Free text, to allow entering custom values.

Multiple select

If checked, it allows to select multiple values. Else it only allow to select one value.

Use suggest

This property only works in combination with input display type: it allows to display a suggest list when the user is typing in the input text, and to select from it.

Allow large strings

This property has been introduced in XWiki 11.5RC1 and allow to store values with more than 255 characters.

Size of the corresponding form element in edit mode

This property is useful only with *select* display, it allows to specify the number of options to display in the select.

Multiselect separators (for editing)

This property allows to specify some operators used to distinguish multiple values in a single string, in edit mode.
By default, the value accepted separators are "|", "," and " ".
For example, if you send the value "Foo|Bar|Baz" in edit, it would be considered as the three values: Foo, Bar and Baz.

Join separator (for display)

This property allows to specify a string that will be used to join the values selected in the list.
For example if this property contains the value "+++", and the selected value are Foo, Bar et Baz, the produced output will be: Foo+++Bar+++Baz.

Sort

Allows to sort the options.

Free text

This option should be used in combination with an input display type.
If set to allows or discouraged, it allows user to type a custom text that is not part of the predefined values.
If set to forbidden, only the values that are specified can be used.

Relational Storage

TBD

Cache

TBD

Default Value

The value selected by default.

Values

The list of values to propose in the Static List.
The edit separators must be used to separate the different values.
Note that if Free text is properly set, users might also be able to enter a custom value.

Tags:
Created by Simon Urli on 2019/05/29
   

Get Connected