Package com.adobe.cq.forms.core.components.models.form

Interface Container

All Superinterfaces:

Base, BaseConstraint, Component, com.adobe.cq.export.json.ComponentExporter, com.adobe.cq.export.json.ContainerExporter, FormComponent

All Known Subinterfaces:

FormContainer, Fragment, Panel, TermsAndConditions

All Known Implementing Classes:

AbstractContainerImpl

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

Defines the form Container Sling Model used for form container component (like fieldset or panel)

Since:

com.adobe.cq.forms.core.components.models.form 0.0.1

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.cq.forms.core.components.models.form.BaseConstraint

BaseConstraint.Type

Field Summary

Fields inherited from interface com.adobe.cq.forms.core.components.models.form.Base

DATE_FORMATTER, DEFAULT_LANGUAGE

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

PN_ID

Fields inherited from interface com.adobe.cq.forms.core.components.models.form.FormComponent

CUSTOM_PROPERTY_WRAPPER

Method Summary

Modifier and Type	Method	Description
default @Nullable java.lang.String	getAppliedCssClasses()
@NotNull java.util.Map<java.lang.String,java.lang.String>	getColumnClassNames()
int	getColumnCount()
com.day.cq.wcm.foundation.model.export.AllowedComponentsExporter	getExportedAllowedComponents()
default @NotNull java.util.Map<java.lang.String,? extends com.adobe.cq.export.json.ComponentExporter>	getExportedItems()
default @NotNull java.lang.String[]	getExportedItemsOrder()
default @NotNull java.lang.String	getExportedType()
@Nullable java.lang.String	getGridClassNames()
java.util.List<? extends com.adobe.cq.export.json.ComponentExporter>	getItems()	Returns the list of items present inside the container as an array.
default @Nullable java.lang.String	getRoleAttribute()
default java.lang.Boolean	isRequired()	Returns true if field is required, otherwise false.

Methods inherited from interface com.adobe.cq.forms.core.components.models.form.Base

getConstraintMessages, getDescription, getHtmlScreenReaderText, getLabel, getLang, getScreenReaderText, getTooltip, isEnabled, isTooltipVisible

Methods inherited from interface com.adobe.cq.forms.core.components.models.form.BaseConstraint

getType, getValidationExpression

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

getData, getId

Methods inherited from interface com.adobe.cq.forms.core.components.models.form.FormComponent

getDataRef, getDorProperties, getEvents, getFieldType, getName, getPath, getProperties, getRules, isVisible, setI18n

Method Detail

getItems

java.util.List<? extends com.adobe.cq.export.json.ComponentExporter> getItems()

Returns the list of items present inside the container as an array.

Returns:

list of items

Since:

com.adobe.cq.forms.core.components.models.form 0.0.1

getExportedItems

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

Specified by:

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

Since:

com.adobe.cq.forms.core.components.models.form 0.0.1

See Also:

ContainerExporter.getExportedItems()

isRequired

default java.lang.Boolean isRequired()

Description copied from interface: BaseConstraint

Returns true if field is required, otherwise false.

Specified by:

isRequired in interface BaseConstraint

Returns:

true if field is required, otherwise false

getExportedItemsOrder

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

Specified by:

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

getExportedType

@NotNull
default @NotNull java.lang.String getExportedType()

Specified by:

getExportedType in interface Base

Specified by:

getExportedType in interface Component

Specified by:

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

Since:

com.adobe.cq.forms.core.components.models.form 0.0.1

See Also:

ComponentExporter.getExportedType()

getAppliedCssClasses

@Nullable
default @Nullable java.lang.String getAppliedCssClasses()

Specified by:

getAppliedCssClasses in interface Component

getRoleAttribute

@Nullable
default @Nullable java.lang.String getRoleAttribute()

Returns:

returns the role attribute that will be applied on the container.

Since:

com.adobe.cq.forms.core.components.models.form 5.4.3

getGridClassNames

@Nullable
@Nullable java.lang.String getGridClassNames()

Returns:

The CSS class names to be applied to the current grid.

getColumnClassNames

@NotNull
@NotNull java.util.Map<java.lang.String,java.lang.String> getColumnClassNames()

Returns:

The CSS class names associated with each responsive grid column and listed by column name

getColumnCount

int getColumnCount()

Returns:

The number of columns available for direct children in the grid.

getExportedAllowedComponents

com.day.cq.wcm.foundation.model.export.AllowedComponentsExporter getExportedAllowedComponents()

Returns:

Allowed Components object for the current grid.