@ConsumerType public interface List extends ComponentExporter
List
Sling Model used for the /apps/core/wcm/components/list
component. This component
currently only supports page lists.Modifier and Type | Field and Description |
---|---|
static String |
PN_DATE_FORMAT
Name of the resource property indicating which date format should be used when the list items render their modification date.
|
static String |
PN_LINK_ITEMS
Name of the boolean resource property indication if the items should render a link to the page they represent.
|
static String |
PN_ORDER_BY
Name of the resource property indicating by which criterion the sort is performed.
|
static String |
PN_PAGES
Name of the resource property storing the list of pages to be rendered if the source of the list is
static . |
static String |
PN_PARENT_PAGE
Name of the resource property storing the root page from which to build the list if the source of the list is
children . |
static String |
PN_SEARCH_IN
Name of the resource property storing where a search should be performed if the source of the list is
search . |
static String |
PN_SHOW_DESCRIPTION
Name of the boolean resource property indicating if the list items should render a description.
|
static String |
PN_SHOW_MODIFICATION_DATE
Name of the boolean resource property indicating if the list items should render the modification date of each item.
|
static String |
PN_SORT_ORDER
Name of the resource property indicating how the list items should be sorted.
|
static String |
PN_SOURCE
Name of the resource property indicating how the list will be built.
|
static String |
PN_TAGS
Name of the resource property storing the tags that will be used for building the list if the source of the list is
tags . |
static String |
PN_TAGS_MATCH
Name of the resource property indicating if the matching against tags can accept any tag from the tag list.
|
static String |
PN_TAGS_PARENT_PAGE
Name of the resource property storing the root from where the tag search is performed.
|
Modifier and Type | Method and Description |
---|---|
default String |
getDateFormatString()
Returns the date format used to display the last modification date of the list's items.
|
default @NotNull String |
getExportedType()
Returns the type of the resource for which the export is performed.
|
default Collection<Page> |
getItems()
Deprecated.
since 12.1.0: use
getListItems() instead |
default @NotNull Collection<ListItem> |
getListItems()
Returns the list's items collection, as
ListItem s elements. |
default boolean |
linkItems()
Returns
true if the list's items should link to the corresponding Page s they represent. |
default boolean |
showDescription()
Returns
true if the list's items should render their description. |
default boolean |
showModificationDate()
Returns
true if the list's items should render their last modification date. |
static final String PN_SOURCE
children
- the list will be built from the child pages of the page identified by PN_PARENT_PAGE
static
- the list will be built from a custom set of pages, stored by the PN_PAGES
propertysearch
- the list will be built from the result of a search querytags
- the list will be built from the sub-pages of the page identified by PN_TAGS_PARENT_PAGE
which are tagged with the tags stored by the PN_TAGS
propertystatic final String PN_PAGES
static
.PN_SOURCE
,
Constant Field Valuesstatic final String PN_PARENT_PAGE
children
.PN_SOURCE
,
Constant Field Valuesstatic final String PN_TAGS_PARENT_PAGE
PN_SOURCE
,
Constant Field Valuesstatic final String PN_TAGS
tags
.PN_SOURCE
,
Constant Field Valuesstatic final String PN_TAGS_MATCH
any
.PN_SOURCE
,
Constant Field Valuesstatic final String PN_SHOW_DESCRIPTION
static final String PN_SHOW_MODIFICATION_DATE
static final String PN_LINK_ITEMS
static final String PN_SEARCH_IN
search
.PN_SOURCE
,
Constant Field Valuesstatic final String PN_SORT_ORDER
asc
, desc
.static final String PN_ORDER_BY
title
,
modified
.static final String PN_DATE_FORMAT
@Deprecated default Collection<Page> getItems()
getListItems()
insteadPage
elements.Collection
of Page
sdefault
in 12.1.0@NotNull default @NotNull Collection<ListItem> getListItems()
ListItem
s elements.Collection
of ListItem
sdefault boolean linkItems()
true
if the list's items should link to the corresponding Page
s they represent.true
if the pages should be linked, false
otherwisedefault
in 12.1.0default boolean showDescription()
true
if the list's items should render their description.true
if page description should be shown, false
otherwisedefault
in 12.1.0default boolean showModificationDate()
true
if the list's items should render their last modification date.true
if modification date should be shown, false
otherwisedefault
in 12.1.0default String getDateFormatString()
default
in 12.1.0showModificationDate()
@NotNull default @NotNull String getExportedType()
ComponentExporter
Returns the type of the resource for which the export is performed.
NOTE: methods whose JSON serialization would lead to the same JSON property name (":type") will not be serialized.
getExportedType
in interface ComponentExporter
ComponentExporter.getExportedType()
Copyright © 2010 - 2020 Adobe. All Rights Reserved