@Version("5.11.0")

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

This package defines the Sling Models exposed by the Adobe Experience Manager Forms Components Bundle for the form components.

Implementors of this API can choose which API level they support, by implementing all the methods up to a specified version of the API. All the provided interfaces document in which API version they were added. Furthermore, all methods also specify the API version in which they were introduced and deprecated.

All the interfaces from this package provide default methods that throw UnsupportedOperationExceptions. The reasoning behind this pattern is that implementors can upgrade the bundle without being forced to implement all the new methods provided by a newer API version, since the interfaces from this package are ConsumerTypes. An UnsupportedOperationException could be thrown when a component script would start using the newer API, without the actual implementation to support it. This can happen when an implementor migrates a proxy component to a newer version of the core component it proxies and a custom Sling Model implementation, supporting an older API version, is bound to this proxy component resource type.

Interface Summary

Interface	Description
AutoSaveConfiguration	Defines the auto save configuration AutoSaveConfiguration
Base	A base interface to be extended by all the different types of form elements.
BaseConstraint	A base interface which specifies the different form field constraints
Button	Defines the Button Sling Model used for the /apps/core/fd/components/form/button component.
Captcha	Defines a base interface to be extended by all the different types of captcha.
CheckBox	Defines the form CheckBox Sling Model used for the /apps/core/fd/components/form/checkbox/v1/checkbox component.
CheckBoxGroup	Defines the form CheckBoxGroup Sling Model used for the /apps/core/fd/components/form/checkboxgroup/v1/checkboxgroup component.
Container	Defines the form Container Sling Model used for form container component (like fieldset or panel)
ContainerConstraint	A interface which specifies the different form container constraints
DateConstraint	A interface which specifies the different form date type constraints
DatePicker	Defines the form DatePicker Sling Model used for the /apps/core/fd/components/form/datepicker/v1/datepicker component.
DropDown	Defines the form DropDown Sling Model used for the /apps/core/fd/components/form/dropdown/v1/dropdown component.
Field	Defines the form Field Sling Model used for form field component.
FileConstraint	Interface for constraints applicable to file attachments
FileInput	Defines the form FileInput Sling Model used for the /apps/core/fd/components/form/fileinput/v1/fileinput component.
FormatConstraint
FormClientLibManager	Defines the FormClientLibManager Sling Model to perform operation related to client libraries.
FormComponent
FormConfigurationProvider	This interface provides the configurations for the form container, @since 5.4.2
FormContainer	Defines the form container FormContainer Sling Model used for the /apps/core/fd/components/form/formcontainer component.
FormMetaData	Defines the form metadata
FormStructureParser	Defines the FormStructureParser Sling Model to access the form container path from page or any child.
FormTitle	Defines the form Title Sling Model used for the /apps/core/fd/components/form/title/v2/title component.
Fragment	Defines the form Fragment Sling Model used for the /apps/core/fd/components/form/fragment/v1/fragment component.
HCaptcha	Defines the form HCaptcha Sling Model used for the /apps/core/fd/components/form/hcaptcha/v1/hcaptcha component.
HtlUtil
Label	Interface for a label
NumberConstraint	Deprecated. Use NumberConstraintV2 instead.
NumberConstraintV2	An interface which specifies the different form number type constraints with Number type.
NumberInput	Defines the form NumberInput Sling Model used for the /apps/core/fd/components/form/numberinput/v1/numberinput component.
OptionsConstraint	Interface for options constraints (for radio button, check box and drop down type of fields)
Panel	Defines the form panel Sling Model used for the /apps/core/fd/components/form/panel/v1/panel component.
RadioButton	Defines the form RadioGroup Sling Model used for the /apps/core/fd/components/form/radiogroup/v1/radiogroup component.
Review	Defines the Review Sling Model used for the /apps/core/fd/components/form/review component.
StaticImage
StringConstraint	A interface which specifies the different form string type constraints
Switch	Defines the Switch Sling Model used for the /apps/core/fd/components/form/switch component.
TermsAndConditions	Defines the form TermsAndConditions Sling Model used for the /apps/core/fd/components/form/termsandconditions/v1/termsandconditions component.
Text	Defines the form Text Sling Model used for the /apps/core/fd/components/form/text/v1/text component.
TextInput	Defines the form Text Sling Model used for the /apps/core/fd/components/form/textinput/v1/textinput component.
Turnstile	Defines the form Turnstile Sling Model used for the /apps/core/fd/components/form/turnstile/v1/turnstile component.

Enum Summary

Enum	Description
AssistPriority	Defines the assist priority type.
AutoSaveConfiguration.AutoSaveStrategyType
BaseConstraint.Type	Defines the data type.
Captcha.CaptchaDisplayMode	Defines the display mode for captcha.
CheckBox.Orientation	Defines the orientation for checkbox.
ConstraintType	Defines the constraint type.
FieldType
FormatConstraint.Format
ThankYouOption