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

Interface LayoutContainer

All Superinterfaces:

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

@ConsumerType
public interface LayoutContainer
extends Container

Defines the LayoutContainer Sling Model used for the /apps/core/wcm/components/container component.

Since:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LayoutContainer.LayoutType Enumeration of supported layout types for the container component

Field Summary

Fields

Modifier and Type	Field and Description
static String	PN_LAYOUT Name of the resource property that indicates the layout that should be used by the container component.

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

PN_BACKGROUND_COLOR, PN_BACKGROUND_COLOR_ENABLED, PN_BACKGROUND_COLOR_SWATCHES_ONLY, PN_BACKGROUND_IMAGE_ENABLED, PN_BACKGROUND_IMAGE_REFERENCE

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

PN_ID

Method Summary

Modifier and Type	Method and Description
default String	getAccessibilityLabel() Returns an accessibility label that describes the container.
default @NotNull LayoutContainer.LayoutType	getLayout() Returns the LayoutContainer.LayoutType to be used by the container component
default String	getRoleAttribute() Returns a role attribute to be used on the container.

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

getBackgroundStyle, getExportedItems, getExportedItemsOrder, getItems

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

getAppliedCssClasses, getData, getExportedType, getId

Field Detail

PN_LAYOUT

static final String PN_LAYOUT

Name of the resource property that indicates the layout that should be used by the container component.

Since:

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

See Also:

Constant Field Values

Method Detail

getLayout

@NotNull
default @NotNull LayoutContainer.LayoutType getLayout()

Returns the LayoutContainer.LayoutType to be used by the container component

Returns:

LayoutContainer.LayoutType for the container component

Since:

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

getAccessibilityLabel

default String getAccessibilityLabel()

Returns an accessibility label that describes the container.

Returns:

an accessibility label for the container

Since:

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

getRoleAttribute

default String getRoleAttribute()

Returns a role attribute to be used on the container.

Returns:

a role attribute for the container

Since:

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