com.adobe.cq.wcm.core.components.util

Class AbstractComponentImpl

java.lang.Object

com.adobe.cq.wcm.core.components.util.AbstractComponentImpl

All Implemented Interfaces:

com.adobe.cq.export.json.ComponentExporter, Component

@ConsumerType
public abstract class AbstractComponentImpl
extends Object
implements Component

Abstract class that can be used as a base class for Component implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.day.cq.wcm.api.components.Component	component The component.
protected @Nullable com.day.cq.wcm.api.components.ComponentContext	componentContext The component context.
protected SlingHttpServletRequest	request The current request.
protected Resource	resource The current resource.

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

PN_ID

Constructor Summary

Constructors

Constructor and Description
AbstractComponentImpl()

Method Summary

Modifier and Type	Method and Description
@Nullable String	getAppliedCssClasses() See Component.getAppliedCssClasses()
protected @NotNull ComponentData	getComponentData() Override this method to provide a different data model for your component.
protected com.day.cq.wcm.api.Page	getCurrentPage() Getter for current page.
@Nullable ComponentData	getData() See Component.getData()
@NotNull String	getExportedType()
@NotNull String	getId() Returns the HTML id of the the component's root element
protected void	setCurrentPage(com.day.cq.wcm.api.Page currentPage) Setter for current page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

request

protected SlingHttpServletRequest request

The current request.

resource

protected Resource resource

The current resource.

component

@Nullable
protected com.day.cq.wcm.api.components.Component component

The component.

componentContext

@Nullable
protected @Nullable com.day.cq.wcm.api.components.ComponentContext componentContext

The component context.

Constructor Detail

AbstractComponentImpl

public AbstractComponentImpl()

Method Detail

getCurrentPage

protected com.day.cq.wcm.api.Page getCurrentPage()

Getter for current page.

Returns:

The current Page

setCurrentPage

protected void setCurrentPage(com.day.cq.wcm.api.Page currentPage)

Setter for current page.

Parameters:

currentPage - The Page to set

getId

@NotNull
public @NotNull String getId()

Description copied from interface: Component

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

Specified by:

getId in interface Component

Returns:

HTML id of the component's root element

getExportedType

@NotNull
public @NotNull String getExportedType()

Specified by:

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

Specified by:

getExportedType in interface Component

See Also:

ComponentExporter.getExportedType()

getData

@Nullable
public @Nullable ComponentData getData()

See Component.getData()

Specified by:

getData in interface Component

Returns:

The component data

getAppliedCssClasses

@Nullable
public @Nullable String getAppliedCssClasses()

See Component.getAppliedCssClasses()

Specified by:

getAppliedCssClasses in interface Component

Returns:

The component styles/css class names

getComponentData

@NotNull
protected @NotNull ComponentData getComponentData()

Override this method to provide a different data model for your component. This will be called by getData() in case the datalayer is activated.

Returns:

The component data.