Package com.coremedia.blueprint.common.layout

Interface Container<T>

All Known Subinterfaces:
CMCollection<T>, CMDynamicList<T>, CMGallery<T>, CMQueryList, DynamizableContainer, PageGridPlacement
All Known Implementing Classes:
DynamizableCMTeasableContainer
public interface Container<T>

  • Method Details

    • getContainerMetadata

      @NonNull default List<Object> getContainerMetadata()

    • getItems

      List<? extends T> getItems()
      Retrieves the items of the implementing class.

      It is assumed that implementations of this method take care of proper cache dependency handling.

      Returns:
      a list of items computed for the backing content 'proxy' object

    • getItemsMetadata

      @NonNull default List<Object> getItemsMetadata()

    • getFlattenedItems

      @Deprecated(since="2004") List<?> getFlattenedItems()
      Deprecated.
      since 2004. Flattening should be handled via dedicated templates to preserve PBE information.
      Returns the items, transitively flattening inner containers.

    • isPaginated

      default boolean isPaginated()
      Check whether the container supports pagination
      Returns:
      true if pagination is supported, false otherwise
      Since:
      1901

    • asPagination

      default Pagination asPagination()
      Returns a Pagination with page number 0 which is backed by this container.

      If isPaginated() is false, the result is unspecified.

      Since:
      1901

    • asPagination

      default Pagination asPagination(int pageNum)
      Returns a Pagination with the given page number which is backed by this container.

      If isPaginated() is false, the result is unspecified.

      Since:
      1901