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

Interface Breadcrumb

  • All Superinterfaces:
    Component, ComponentExporter
    @ConsumerType
public interface Breadcrumb
extends Component
    Defines the Breadcrumb Sling Model used for the /apps/core/wcm/components/breadcrumb component.
    Since:
    com.adobe.cq.wcm.core.components.models 11.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PN_HIDE_CURRENT
      Name of the resource property that will indicate if the current page should not be present in the collection returned by getItems().
      static java.lang.String PN_SHOW_HIDDEN
      Name of the resource property that will indicate if pages that are hidden for navigation will still be displayed.
      static java.lang.String PN_START_LEVEL
      Name of the resource property that will indicate from which level starting from the current page the items from the collection returned by getItems() will be accumulated.

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

        PN_ID

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default @NotNull java.lang.String getExportedType()
      Returns the type of the resource for which the export is performed.
      default java.util.Collection<NavigationItem> getItems()
      Creates collection of pages(from site hierarchy of current page) for the breadcrumb component

    • Field Detail

      • PN_SHOW_HIDDEN

        static final java.lang.String PN_SHOW_HIDDEN
        Name of the resource property that will indicate if pages that are hidden for navigation will still be displayed.
        Since:
        com.adobe.cq.wcm.core.components.models 11.1.0
        See Also:
        Constant Field Values

      • PN_HIDE_CURRENT

        static final java.lang.String PN_HIDE_CURRENT
        Name of the resource property that will indicate if the current page should not be present in the collection returned by getItems().
        Since:
        com.adobe.cq.wcm.core.components.models 11.1.0
        See Also:
        Constant Field Values

      • PN_START_LEVEL

        static final java.lang.String PN_START_LEVEL
        Name of the resource property that will indicate from which level starting from the current page the items from the collection returned by getItems() will be accumulated.
        Since:
        com.adobe.cq.wcm.core.components.models 11.1.0
        See Also:
        Constant Field Values

    • Method Detail

      • getItems

        default java.util.Collection<NavigationItem> getItems()
        Creates collection of pages(from site hierarchy of current page) for the breadcrumb component
        Returns:
        Collection of breadcrumb items
        Since:
        com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.1.0

      • getExportedType

        @NotNull
default @NotNull java.lang.String getExportedType()
        Description copied from interface: 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.

        Specified by:
        getExportedType in interface Component
        Specified by:
        getExportedType in interface ComponentExporter
        Returns:
        the type of the component
        Since:
        com.adobe.cq.wcm.core.components.models 12.2.0
        See Also:
        ComponentExporter.getExportedType()