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

Interface Breadcrumb

All Superinterfaces:

Component, com.adobe.cq.export.json.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 and Description
static 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 String	PN_SHOW_HIDDEN Name of the resource property that will indicate if pages that are hidden for navigation will still be displayed.
static 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

Modifier and Type	Method and Description
default @NotNull String	getExportedType()
default Collection<NavigationItem>	getItems() Creates collection of pages(from site hierarchy of current page) for the breadcrumb component

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

getData, getId

Field Detail

PN_SHOW_HIDDEN

static final 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 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 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 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 String getExportedType()

Specified by:

getExportedType in interface Component

Specified by:

getExportedType in interface com.adobe.cq.export.json.ComponentExporter

Since:

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

See Also:

ComponentExporter.getExportedType()