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

Interface Navigation

All Superinterfaces:
Component, ComponentExporter
public interface Navigation extends Component
Defines the Navigation Sling Model used for the /apps/core/wcm/components/navigation component.
Since:
com.adobe.cq.wcm.core.components.models 12.2.0

  • Field Details

    • PN_NAVIGATION_ROOT

      static final String PN_NAVIGATION_ROOT
      Name of the resource / configuration policy property that defines the site's navigation root for which to build the navigation tree. The property should provide a String value.
      Since:
      com.adobe.cq.wcm.core.components.models 12.2.0
      See Also:

    • PN_SKIP_NAVIGATION_ROOT

      @Deprecated static final String PN_SKIP_NAVIGATION_ROOT
      Deprecated.
      since 12.11.0
      Name of the resource / configuration policy property that defines if the resulted navigation tree should skip including the navigation root, but include its children. The property should provide a Boolean value (true if the site root should be omitted, false otherwise).
      Since:
      com.adobe.cq.wcm.core.components.models 12.2.0
      See Also:

    • PN_STRUCTURE_START

      static final String PN_STRUCTURE_START
      Name of the resource / configuration policy property that defines the start level of navigation, relative to the PN_NAVIGATION_ROOT, from which to start building the tree. The property should provide a Long value.
      Since:
      com.adobe.cq.wcm.core.components.models 12.11.0
      See Also:

    • PN_COLLECT_ALL_PAGES

      static final String PN_COLLECT_ALL_PAGES
      Name of the resource / configuration policy property that defines if the resulted navigation tree should collect all child pages of the configured PN_NAVIGATION_ROOT. The property should provide a Boolean value. When this value property is set to true, the PN_STRUCTURE_DEPTH property will be ignored.
      Since:
      com.adobe.cq.wcm.core.components.models 12.2.0
      See Also:

    • PN_STRUCTURE_DEPTH

      static final String PN_STRUCTURE_DEPTH
      Name of the resource / configuration policy property that defines the navigation structure depth, relative to the PN_NAVIGATION_ROOT, where items will be searched for building the navigation tree. The property should provide a Long value.
      Since:
      com.adobe.cq.wcm.core.components.models 12.2.0
      See Also:

  • Method Details

    • getItems

      default List<NavigationItem> getItems()
      Returns the list of navigation items.
      Returns:
      a list of navigation items
      Since:
      com.adobe.cq.wcm.core.components.models 12.2.0

    • getAccessibilityLabel

      default String getAccessibilityLabel()
      Retrieves an accessibility label that describes the navigation.
      Returns:
      an accessibility label for the navigation
      Since:
      com.adobe.cq.wcm.core.components.models 12.9.0