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

Interface Container

All Superinterfaces:

Component, ComponentExporter, ContainerExporter

All Known Subinterfaces:

Accordion, Carousel, LayoutContainer, Tabs

@ConsumerType
public interface Container
extends Component, 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	Description
static java.lang.String	PN_BACKGROUND_COLOR	Name of the resource property that indicates the background color
static java.lang.String	PN_BACKGROUND_COLOR_ENABLED	Name of the configuration policy property that indicates if background colors are enabled
static java.lang.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 java.lang.String	PN_BACKGROUND_IMAGE_ENABLED	Name of the configuration policy property that indicates if background images are enabled
static java.lang.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	Description
default @Nullable java.lang.String	getBackgroundStyle()	Returns the background CSS style to be applied to the component's root element
default @NotNull java.util.Map<java.lang.String,? extends ComponentExporter>	getExportedItems()	Returns the map of all exported child items (resource names from Sling Model classes).
default @NotNull java.lang.String[]	getExportedItemsOrder()	Returns the order of items in the map.
default @NotNull java.util.List<ListItem>	getItems()	Returns a list of container items

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

getAppliedCssClasses, getData, getExportedType, getId

Field Detail

PN_BACKGROUND_IMAGE_ENABLED

static final java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.util.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 java.lang.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 java.util.Map<java.lang.String,? extends ComponentExporter> getExportedItems()

Description copied from interface: ContainerExporter

Returns the map of all exported child items (resource names from Sling Model classes).

NOTE: Methods whose JSON serialization would lead to the same JSON property name (":items") will not be serialized.

Specified by:

getExportedItems in interface ContainerExporter

Returns:

the map of all exported child items

Since:

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

See Also:

ContainerExporter.getExportedItems()

getExportedItemsOrder

@NotNull
default @NotNull java.lang.String[] getExportedItemsOrder()

Description copied from interface: ContainerExporter

Returns the order of items in the map.

NOTE: This information is required because the JSON specification and most implementations don't provide a stable order of items in JSON objects. Methods whose JSON serialization would lead to the same JSON property name (":order") will not be serialized.

Specified by:

getExportedItemsOrder in interface ContainerExporter

Returns:

the order of the items in the map; the array can be empty if the item order is not provided by the underlying persistence layer

Since:

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

See Also:

ContainerExporter.getExportedItemsOrder()