Interface LayoutContainer
-
- All Superinterfaces:
Component
,ComponentExporter
,Container
,ContainerExporter
@ConsumerType public interface LayoutContainer extends Container
Defines theLayoutContainer
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 Description static class
LayoutContainer.LayoutType
Enumeration of supported layout types for the container component
-
Field Summary
Fields Modifier and Type Field 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
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default String
getAccessibilityLabel()
Returns an accessibility label that describes the container.default @NotNull LayoutContainer.LayoutType
getLayout()
Returns theLayoutContainer.LayoutType
to be used by the container componentdefault String
getRoleAttribute()
Returns a role attribute to be used on the container.-
Methods inherited from interface com.adobe.cq.wcm.core.components.models.Component
getAppliedCssClasses, getData, getExportedType, getId
-
Methods inherited from interface com.adobe.cq.wcm.core.components.models.Container
getBackgroundStyle, getExportedItems, getExportedItemsOrder, getItems
-
-
-
-
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 theLayoutContainer.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
-
-