Interface Navigation
-
- All Superinterfaces:
Component
,ComponentExporter
public interface Navigation extends Component
Defines theNavigation
Sling Model used for the/apps/core/wcm/components/navigation
component.- Since:
- com.adobe.cq.wcm.core.components.models 12.2.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.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 configuredPN_NAVIGATION_ROOT
.static java.lang.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 java.lang.String
PN_SKIP_NAVIGATION_ROOT
Deprecated.since 12.11.0static java.lang.String
PN_STRUCTURE_DEPTH
Name of the resource / configuration policy property that defines the navigation structure depth, relative to thePN_NAVIGATION_ROOT
, where items will be searched for building the navigation tree.static java.lang.String
PN_STRUCTURE_START
Name of the resource / configuration policy property that defines the start level of navigation, relative to thePN_NAVIGATION_ROOT
, from which to start building the tree.
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default java.lang.String
getAccessibilityLabel()
Retrieves an accessibility label that describes the navigation.default @NotNull java.lang.String
getExportedType()
Returns the type of the resource for which the export is performed.default java.util.List<NavigationItem>
getItems()
Returns the list of navigation items.
-
-
-
Field Detail
-
PN_NAVIGATION_ROOT
static final java.lang.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:
- Constant Field Values
-
PN_SKIP_NAVIGATION_ROOT
@Deprecated static final java.lang.String PN_SKIP_NAVIGATION_ROOT
Deprecated.since 12.11.0Name 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:
- Constant Field Values
-
PN_STRUCTURE_START
static final java.lang.String PN_STRUCTURE_START
Name of the resource / configuration policy property that defines the start level of navigation, relative to thePN_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:
- Constant Field Values
-
PN_COLLECT_ALL_PAGES
static final java.lang.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 configuredPN_NAVIGATION_ROOT
. The property should provide a Boolean value. When this value property is set totrue
, thePN_STRUCTURE_DEPTH
property will be ignored.- Since:
- com.adobe.cq.wcm.core.components.models 12.2.0
- See Also:
- Constant Field Values
-
PN_STRUCTURE_DEPTH
static final java.lang.String PN_STRUCTURE_DEPTH
Name of the resource / configuration policy property that defines the navigation structure depth, relative to thePN_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:
- Constant Field Values
-
-
Method Detail
-
getItems
default java.util.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
-
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 interfaceComponent
- Specified by:
getExportedType
in interfaceComponentExporter
- Returns:
- the type of the component
- Since:
- com.adobe.cq.wcm.core.components.models 12.2.0
- See Also:
ComponentExporter.getExportedType()
-
getAccessibilityLabel
default java.lang.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
-
-