List Picker Component - BloomReach Experience - Open Source CMS
07-01-2019

List Picker Component

Class Name

The List Picker Component is implemented by the class

org.onehippo.cms7.essentials.components.EssentialsListPickerComponent

Purpose

This component makes a number of related documents (max 10) available as Java beans to the rendering template. All documents are hand-picked, preferably in the Channel Manager's Channel Editor.

The component can be used to display a hand-crafted (as opposed to queried) list of items, where each item is represented by a a separate document. While the document picker does not restrict the types of document you pick, you will typically want to pick documents of the same type.

The component provides the picked documents to the rendering template as a pageable list. While pagination on this list is supported, the limitation to pick no more than 10 documents makes it likely that you won't find much advantage in using pagination for this list on the site.

Component Parameters

Name Description
documentX X represents a number between 1 and 10 (inclusive). The value represents the repository path to the document (handle), relative to the site's content root. If the path doesn't map to a document, it is silently ignored.
pageSize Integer number of items to show on a page, 10 (all) is used by default.
page 1-based integer specifying the requested page. Default to 1 if not specified. Is overruled by request parameter.

Request Parameters

 Name  Description
 page 1-based integer specifying the requested page. Default to 1 if none is specified. Overrules component parameter.

Rendering Attributes

Name Type Description
pageable org.onehippo.cms7.essentials.components.paging.Pageable<HippoDocument> A pageable collection containing all picked and successfully retrieved HippoDocuments. The collection also provides access to the page size and number.
Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?