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