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

Interface Container

All Superinterfaces:

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

All Known Subinterfaces:

Accordion, Carousel, LayoutContainer, Tabs

@ConsumerType
public interface Container
extends Component, com.adobe.cq.export.json.ContainerExporter

A base interface to be extended by containers such as the Carousel, Tabs and Accordion models.

Since:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PN_BACKGROUND_COLOR Name of the resource property that indicates the background color
static String	PN_BACKGROUND_COLOR_ENABLED Name of the configuration policy property that indicates if background colors are enabled
static String	PN_BACKGROUND_COLOR_SWATCHES_ONLY Name of the configuration policy property that indicates if background colors are to be restricted to predefined values
static String	PN_BACKGROUND_IMAGE_ENABLED Name of the configuration policy property that indicates if background images are enabled
static String	PN_BACKGROUND_IMAGE_REFERENCE Name of the resource property that indicates that path to the background image

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

PN_ID

Method Summary

Modifier and Type	Method and Description
default @Nullable String	getBackgroundStyle() Returns the background CSS style to be applied to the component's root element
default @NotNull Map<String,? extends com.adobe.cq.export.json.ComponentExporter>	getExportedItems()
default @NotNull String[]	getExportedItemsOrder()
default @NotNull List<ListItem>	getItems() Returns a list of container items

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

getData, getExportedType, getId

Field Detail

PN_BACKGROUND_IMAGE_ENABLED

static final String PN_BACKGROUND_IMAGE_ENABLED

Name of the configuration policy property that indicates if background images are enabled

Since:

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

See Also:

Constant Field Values

PN_BACKGROUND_COLOR_ENABLED

static final String PN_BACKGROUND_COLOR_ENABLED

Name of the configuration policy property that indicates if background colors are enabled

Since:

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

See Also:

Constant Field Values

PN_BACKGROUND_COLOR_SWATCHES_ONLY

static final String PN_BACKGROUND_COLOR_SWATCHES_ONLY

Name of the configuration policy property that indicates if background colors are to be restricted to predefined values

Since:

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

See Also:

Constant Field Values

PN_BACKGROUND_IMAGE_REFERENCE

static final String PN_BACKGROUND_IMAGE_REFERENCE

Name of the resource property that indicates that path to the background image

Since:

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

See Also:

Constant Field Values

PN_BACKGROUND_COLOR

static final String PN_BACKGROUND_COLOR

Name of the resource property that indicates the background color

Since:

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

See Also:

Constant Field Values

Method Detail

getItems

@NotNull
default @NotNull List<ListItem> getItems()

Returns a list of container items

Returns:

List of container items

Since:

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

getBackgroundStyle

@Nullable
default @Nullable String getBackgroundStyle()

Returns the background CSS style to be applied to the component's root element

Returns:

CSS style string for the component's root element

Since:

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

getExportedItems

@NotNull
default @NotNull Map<String,? extends com.adobe.cq.export.json.ComponentExporter> getExportedItems()

Specified by:

getExportedItems in interface com.adobe.cq.export.json.ContainerExporter

Since:

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

See Also:

ContainerExporter.getExportedItems()

getExportedItemsOrder

@NotNull
default @NotNull String[] getExportedItemsOrder()

Specified by:

getExportedItemsOrder in interface com.adobe.cq.export.json.ContainerExporter

Since:

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

See Also:

ContainerExporter.getExportedItemsOrder()