Package com.adobe.cq.wcm.core.components.models

Interface List

All Superinterfaces:
Component, ComponentExporter
@ConsumerType public interface List extends Component
Defines the List Sling Model used for the /apps/core/wcm/components/list component. This component currently only supports page lists.
Since:
com.adobe.cq.wcm.core.components.models 11.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NN_STATIC
    Name of the child node storing the list items if the source of the list is static.
    static final 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 final String
    PN_DISPLAY_ITEM_AS_TEASER
    Name of the boolean resource property indicating if the list item rendering is delegated to the configured teaser component.
    static final String
    PN_LINK_ITEMS
    Name of the boolean resource property indication if the items should render a link to the page they represent.
    static final String
    PN_LINK_TEXT
    Name of the resource property storing the text of link in the static list item when the source of the list is static.
    static final String
    PN_ORDER_BY
    Name of the resource property indicating by which criterion the sort is performed.
    static final String
    PN_PAGES
    Deprecated.
    since 12.27.0, the latest List implementation relies on the NN_STATIC content structure
    static final 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 final 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 final String
    PN_SHOW_DESCRIPTION
    Name of the boolean resource property indicating if the list items should render a description.
    static final 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 final String
    PN_SORT_ORDER
    Name of the resource property indicating how the list items should be sorted.
    static final String
    PN_SOURCE
    Name of the resource property indicating how the list will be built.
    static final 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 final String
    PN_TAGS_MATCH
    Name of the resource property indicating if the matching against tags can accept any tag from the tag list.
    static final String
    PN_TAGS_PARENT_PAGE
    Name of the resource property storing the root from where the tag search is performed.
    static final String
    PN_TEASER_DELEGATE
    Name of the component property indicating to which teaser component the list item rendering should be delegated.

    Fields inherited from interface com.adobe.cq.wcm.core.components.models.Component

    PN_ID

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    displayItemAsTeaser()
    Returns true if the list's items should be displayed as teasers.
    default String
    getDateFormatString()
    Returns the date format used to display the last modification date of the list's items.
    default Collection<Page>
    getItems()
    Deprecated.
    since 12.1.0: use getListItems() instead
    default @NotNull Collection<ListItem>
    getListItems()
    Returns the list's items collection, as ListItems elements.
    default boolean
    linkItems()
    Returns true if the list's items should link to the corresponding Pages 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.

    Methods inherited from interface com.adobe.cq.wcm.core.components.models.Component

    getAppliedCssClasses, getData, getExportedType, getId

  • Field Details

    • PN_SOURCE

      static final String PN_SOURCE
      Name of the resource property indicating how the list will be built. Possible values are:
      • 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 and external links, stored under the NN_STATIC node
      • search - the list will be built from the result of a search query
      • tags - 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 property
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0
      See Also:

    • PN_PAGES

      static final String PN_PAGES
      Deprecated.
      since 12.27.0, the latest List implementation relies on the NN_STATIC content structure
      Name of the resource property storing the list of pages to be rendered if the source of the list is static.
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0
      See Also:

    • NN_STATIC

      static final String NN_STATIC
      Name of the child node storing the list items if the source of the list is static.
      Since:
      com.adobe.cq.wcm.core.components.models 12.27.0
      See Also:

    • PN_LINK_TEXT

      static final String PN_LINK_TEXT
      Name of the resource property storing the text of link in the static list item when the source of the list is static.
      Since:
      com.adobe.cq.wcm.core.components.models 12.27.0
      See Also:

    • PN_PARENT_PAGE

      static final 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.
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0
      See Also:

    • PN_TAGS_PARENT_PAGE

      static final String PN_TAGS_PARENT_PAGE
      Name of the resource property storing the root from where the tag search is performed.
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0
      See Also:

    • PN_TAGS

      static final 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.
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0
      See Also:

    • PN_TAGS_MATCH

      static final String PN_TAGS_MATCH
      Name of the resource property indicating if the matching against tags can accept any tag from the tag list. The accepted value is any.
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0
      See Also:

    • PN_SHOW_DESCRIPTION

      static final String PN_SHOW_DESCRIPTION
      Name of the boolean resource property indicating if the list items should render a description.
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0
      See Also:

    • PN_SHOW_MODIFICATION_DATE

      static final String PN_SHOW_MODIFICATION_DATE
      Name of the boolean resource property indicating if the list items should render the modification date of each item.
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0
      See Also:

    • PN_DISPLAY_ITEM_AS_TEASER

      static final String PN_DISPLAY_ITEM_AS_TEASER
      Name of the boolean resource property indicating if the list item rendering is delegated to the configured teaser component.
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0
      See Also:

    • PN_SEARCH_IN

      static final String PN_SEARCH_IN
      Name of the resource property storing where a search should be performed if the source of the list is search.
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0
      See Also:

    • PN_SORT_ORDER

      static final String PN_SORT_ORDER
      Name of the resource property indicating how the list items should be sorted. Possible values: asc, desc.
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0
      See Also:

    • PN_ORDER_BY

      static final String PN_ORDER_BY
      Name of the resource property indicating by which criterion the sort is performed. Possible value: title, modified.
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0
      See Also:

    • PN_DATE_FORMAT

      static final String PN_DATE_FORMAT
      Name of the resource property indicating which date format should be used when the list items render their modification date.
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0
      See Also:

    • PN_TEASER_DELEGATE

      static final String PN_TEASER_DELEGATE
      Name of the component property indicating to which teaser component the list item rendering should be delegated.
      Since:
      com.adobe.cq.wcm.core.components.models 12.21.0
      See Also:

  • Method Details

    • getItems

      @Deprecated default Collection<Page> getItems()
      Deprecated.
      since 12.1.0: use getListItems() instead
      Returns the list's items collection, as Page elements.
      Returns:
      Collection of Pages
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.1.0

    • getListItems

      @NotNull default @NotNull Collection<ListItem> getListItems()
      Returns the list's items collection, as ListItems elements.
      Returns:
      Collection of ListItems
      Since:
      com.adobe.cq.wcm.core.components.models 12.2.0

    • displayItemAsTeaser

      default boolean displayItemAsTeaser()
      Returns true if the list's items should be displayed as teasers.
      Returns:
      true if the items should be displayed as teasers, false otherwise
      Since:
      com.adobe.cq.wcm.core.components.models 12.21.0

    • linkItems

      default boolean linkItems()
      Returns true if the list's items should link to the corresponding Pages they represent.
      Returns:
      true if the pages should be linked, false otherwise
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.1.0

    • showDescription

      default boolean showDescription()
      Returns true if the list's items should render their description.
      Returns:
      true if page description should be shown, false otherwise
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.1.0

    • showModificationDate

      default boolean showModificationDate()
      Returns true if the list's items should render their last modification date.
      Returns:
      true if modification date should be shown, false otherwise
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.1.0

    • getDateFormatString

      default String getDateFormatString()
      Returns the date format used to display the last modification date of the list's items.
      Returns:
      format to use for the display of the last modification date.
      Since:
      com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.1.0
      See Also: