public interface Navigation extends ComponentExporter
Navigation
Sling Model used for the /apps/core/wcm/components/navigation
component.Modifier and Type | Field and Description |
---|---|
static 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 . |
static 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.
|
static String |
PN_SKIP_NAVIGATION_ROOT
Deprecated.
since 12.11.0
|
static 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. |
static 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. |
Modifier and Type | Method and Description |
---|---|
default String |
getAccessibilityLabel()
Retrieves an accessibility label that describes the navigation.
|
default @NotNull String |
getExportedType()
Returns the type of the resource for which the export is performed.
|
default List<NavigationItem> |
getItems()
Returns the list of navigation items.
|
static final String PN_NAVIGATION_ROOT
@Deprecated static final String PN_SKIP_NAVIGATION_ROOT
true
if the site root should be
omitted, false
otherwise).static final String PN_STRUCTURE_START
PN_NAVIGATION_ROOT
, from which to start building the tree. The property should provide a Long value.static final String PN_COLLECT_ALL_PAGES
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.static final String PN_STRUCTURE_DEPTH
PN_NAVIGATION_ROOT
, where items will be searched for building the navigation tree. The property should provide a Long value.default List<NavigationItem> getItems()
@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()
default String getAccessibilityLabel()
Copyright © 2010 - 2020 Adobe. All Rights Reserved