Wiki source code of Static List

Version 2.1 by Simon Urli on 2019/05/29

Hide last authors
Simon Urli 1.1 1 Static List allows to store and display single-select or multi-select fields that can be displayed as select, checkbox, radio or suggests fields.
2
3 == Properties ==
4
Simon Urli 2.1 5 We list in the following the properties of Static List and their meanings.
6
Simon Urli 1.1 7 === Display Type ===
8
9 Several types are available for displaying a static list:
10
Simon Urli 2.1 11 * **select**: display the list as an html select
12 * **checkbox**: display the list as checkboxes
13 * **radio**: display the list as a radio button
14 * **input**: display a simple input text. Note that this option might be used in combination with [[Use suggest||anchor="HUseSuggest"]] and [[Free text||anchor="HFreetext"]], to allow entering custom values.
15
Simon Urli 1.1 16 === Multiple select ===
17
18 If checked, it allows to select multiple values. Else it only allow to select one value.
19
20 === Use suggest ===
21
Simon Urli 2.1 22 This property only works in combination with [[input display type||anchor="HDisplayType"]]: it allows to display a suggest list when the user is typing in the input text, and to select from it.
Simon Urli 1.1 23
24 === Allow large strings ===
25
26 This property has been introduced in {{code}}XWiki 11.5RC1{{/code}} and allow to store values with more than 255 characters.
27
28 === Size of the corresponding form element in edit mode ===
29
30 This property is useful only with *select* display, it allows to specify the number of options to display in the select.
31
32 === Multiselect separators (for editing) ===
33
34 This property allows to specify some operators used to distinguish multiple values in a single string, in edit mode.
35 By default, the value accepted separators are "|", "," and " ".
36 For example, if you send the value "Foo|Bar|Baz" in edit, it would be considered as the three values: Foo, Bar and Baz.
37
Simon Urli 2.1 38 === Join separator (for display) ===
Simon Urli 1.1 39
Simon Urli 2.1 40 This property allows to specify a string that will be used to join the values selected in the list.
41 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.
42
43 === Sort ===
44
45 Allows to sort the options.
46
47 === Free text ===
48
49 This option should be used in combination with an [[input display type||anchor="HDisplayType"]].
50 If set to allows or discouraged, it allows user to type a custom text that is not part of the [[predefined values||anchor="HValues"]].
51 If set to forbidden, only the values that are specified can be used.
52
53 === Relational Storage ===
54
55 TBD
56
57 === Cache ===
58
59 TBD
60
61 === Default Value ===
62
63 The value selected by default.
64
65 === Values ===
66
67 The list of values to propose in the Static List.
68 The [[edit separators||anchor="HMultiselectseparators(forediting)"]] must be used to separate the different values.
69 Note that if [[Free text||anchor="HFreetext"]] is properly set, users might also be able to enter a custom value.

Get Connected