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

Interface Component

All Superinterfaces:

ComponentExporter

All Known Subinterfaces:

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

All Known Implementing Classes:

AbstractComponentImpl

@ConsumerType
public interface Component
extends 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	Description
static java.lang.String	PN_ID	Name of the resource property that indicates the HTML id for the component.

Method Summary

Modifier and Type	Method	Description
default @Nullable java.lang.String	getAppliedCssClasses()	Returns the style system information associated with the component
default @Nullable ComponentData	getData()	Returns the data layer information associated with the component
default @NotNull java.lang.String	getExportedType()	Returns the type of the resource for which the export is performed.
default @Nullable java.lang.String	getId()	Returns the HTML id of the the component's root element

Field Detail

PN_ID

static final java.lang.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 java.lang.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

getAppliedCssClasses

@Nullable
default @Nullable java.lang.String getAppliedCssClasses()

Returns the style system information associated with the component

Returns:

CSS classes selected by the content author delimited using a SPACE character

Since:

com.adobe.cq.wcm.core.components.models 12.20.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 interface ComponentExporter

Returns:

the type of the component

Since:

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

See Also:

ComponentExporter.getExportedType()