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

Interface Component

All Superinterfaces:

com.adobe.cq.export.json.ComponentExporter

All Known Subinterfaces:

Accordion, Breadcrumb, Button, Carousel, Container, Download, Embed, ExperienceFragment, Image, LanguageNavigation, LanguageNavigationItem, LayoutContainer, List, ListItem, Navigation, NavigationItem, Page, PdfViewer, ProgressBar, Search, Separator, SocialMediaHelper, Tabs, Teaser, Text, Title

@ConsumerType
public interface Component
extends com.adobe.cq.export.json.ComponentExporter

A base interface to be extended by components that need to provide access to common properties.

Since:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PN_ID Name of the resource property that indicates the HTML id for the component.

Method Summary

Modifier and Type	Method and Description
default @Nullable ComponentData	getData() Returns the data layer information associated with the component
default @NotNull String	getExportedType()
default @Nullable String	getId() Returns the HTML id of the the component's root element

Field Detail

PN_ID

static final String PN_ID

Name of the resource property that indicates the HTML id for the component.

Since:

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

See Also:

Constant Field Values

Method Detail

getId

@Nullable
default @Nullable String getId()

Returns the HTML id of the the component's root element

Returns:

HTML id of the component's root element

Since:

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

getData

@Nullable
default @Nullable ComponentData getData()

Returns the data layer information associated with the component

Returns:

ComponentData object associated with the component

Since:

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

getExportedType

@NotNull
default @NotNull String getExportedType()

Specified by:

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

Since:

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

See Also:

ComponentExporter.getExportedType()