Wiki source code of Using custom enum select picker for Wiki Macro parameters
Last modified by Vincent Massol on 2024/02/20
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | There might be cases where you want to display a Wiki Macro parameter as a select picker of a set of possible values. However, for this you will need a Java Enum defined somewhere in the wiki, that will correspond to those possible values your parameter can take. The easiest way to have that (for now) is to create a Java Enum and bundle it as a jar dependency of your project. | ||
| 2 | |||
| 3 | Here is, for example, how to implement a custom ##Ascending## / ##Descending## select picker for a sort order parameter. | ||
| 4 | |||
| 5 | == Step 1: Java enum == | ||
| 6 | |||
| 7 | Write your custom java enum: | ||
| 8 | |||
| 9 | {{code language="java"}} | ||
| 10 | package your.enum.package; | ||
| 11 | |||
| 12 | public enum SortOrderEnum | ||
| 13 | { | ||
| 14 | asc, | ||
| 15 | desc; | ||
| 16 | } | ||
| 17 | {{/code}} | ||
| 18 | |||
| 19 | {{info}} | ||
| 20 | The values you choose for your enum will correspond to the values saved for your parameter. They are the one that will end up being editable from the wiki editor, so you might prefer using camelCase values instead of ALL_CAPS. | ||
| 21 | {{/info}} | ||
| 22 | |||
| 23 | Then bundle it as a jar, and import it in your instance (by manually placing it in the ##WEB-INF/lib## directory, or using the extension manager). | ||
| 24 | |||
| 25 | == Step 2: Wiki Macro parameter type == | ||
| 26 | |||
| 27 | Simply set your parameter type to ##your.enum.package.SortOrderEnum## in the Wiki Macro page. | ||
| 28 | |||
| 29 | The enum picker will be automatically used in the wysiwyg editor when editing your macro parameter. | ||
| 30 | |||
| 31 | == Step 3: Translations == | ||
| 32 | |||
| 33 | For now, values are being displayed as is. To display a custom title for each value, you'll have to setup translation keys. | ||
| 34 | |||
| 35 | Create a page with a ##XWiki.TranslationDocumentClass## object, where translation keys are the full name of your enum concatenated with the values: | ||
| 36 | |||
| 37 | {{code language="plain"}} | ||
| 38 | your.enum.package.SortOrderEnum.asc=Ascending | ||
| 39 | your.enum.package.SortOrderEnum.desc=Descending | ||
| 40 | {{/code}} |
