Available since version 1.0.0
Generic Lists are a feature allowing easy creation and management of lists of title/value pairs.
How to Use
Generic Lists are represented as CQ Pages under
/etc/acs-commons/lists/age-ranges. They are editable by using the Tools screen:
On a list page, the items in the list are components within a parsys. New items can be created using the Sidekick. Items can be removed using the context menu.
Using Lists in Classic UI Dialogs
One of the primary purposes of Generic Lists is to populate a selection widget in a component (or page) dialog. To do this, set the
options configuration property to the list path plus
/jcr:content.list.json. For example:
This can also be used in multifield scenarios.
In both cases, the JCR property will be set to the value of the list item.
Using Lists in Touch UI Dialogs (since 1.8.0)
In a Touch UI dialog, a generic concept called a datasource is used to populate select-style components. For this, you can use a Generic Lists-specific data source:
Using Lists in Touch UI Asset Metadata Editor (since 1.8.0)
In the Touch UI Asset Metadata Editor, you can provide the name to the list prefixed with /mnt/acs-commons/lists (e.g. _ /mnt/acs-commons/lists/sharethis-services_ for /etc/acs-commons/lists/sharethis-services) as the JSON Path for a Dropdown list. You may optionally include the json extension.
One quirk of the Metadata Asset Editor is that the JSON support is not dynamic. You must update the editor when the list changes.
You will frequently need to do two things with lists:
- Get all the items in the list.
- Lookup the title of a particular value from the list.
To do this, first obtain the
com.day.cq.wcm.api.Page object for the list page:
Then adapt the
Page object to a
GenericList interface has two methods:
getItems()- returns a
java.util.Listof the items in the list.
lookupTitle(String)- return the title of a particular value from the list.