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

Interface FormContainer

  • All Superinterfaces:
    Base, BaseConstraint, Component, com.adobe.cq.export.json.ComponentExporter, Container, com.adobe.cq.export.json.ContainerExporter, FormComponent
    @ConsumerType
public interface FormContainer
extends Container
    Defines the form container FormContainer Sling Model used for the /apps/core/fd/components/form/formcontainer component.
    Since:
    com.adobe.cq.forms.core.components.models.form 0.0.1

    • Field Detail

      • ADOBE_GLOBAL_API_ROOT

        static final java.lang.String ADOBE_GLOBAL_API_ROOT
        Name of the adobe global API root for HTTP API
        Since:
        com.adobe.cq.forms.core.components.models.form 4.0.0
        See Also:
        Constant Field Values

      • FORMS_RUNTIME_API_GLOBAL_ROOT

        static final java.lang.String FORMS_RUNTIME_API_GLOBAL_ROOT
        Name of the forms runtime API root for HTTP API
        Since:
        com.adobe.cq.forms.core.components.models.form 4.0.0
        See Also:
        Constant Field Values

      • PN_RUNTIME_DOCUMENT_PATH

        static final java.lang.String PN_RUNTIME_DOCUMENT_PATH
        Name of the resource property that defines the document path containing the json
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1
        See Also:
        Constant Field Values

      • PN_CLIENT_LIB_REF

        static final java.lang.String PN_CLIENT_LIB_REF
        Name of the resource property that defines the reference to the client lib
        Since:
        com.adobe.cq.forms.core.components.models.form 2.0.0
        See Also:
        Constant Field Values

      • DEFAULT_FORMS_SPEC_VERSION

        static final java.lang.String DEFAULT_FORMS_SPEC_VERSION
        See Also:
        Constant Field Values

    • Method Detail

      • getMetaData

        FormMetaData getMetaData()
        Returns form metadata FormMetaData
        Returns:
        form meta data
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getAdaptiveFormVersion

        default java.lang.String getAdaptiveFormVersion()
        Returns the version of the adaptive form specification
        Since:
        com.adobe.cq.forms.core.components.models.form 2.0.0

      • getSchemaRef

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

      • getSchemaType

        @Nullable
default @Nullable GuideSchemaType getSchemaType()
        Returns schema type GuideSchemaType
        Returns:
        schema type
        Since:
        com.adobe.cq.forms.core.components.models.form 2.1.0

      • getClientLibRef

        @Nullable
default @Nullable java.lang.String getClientLibRef()
        Returns name of the client lib category
        Returns:
        name of the client lib category
        Since:
        com.adobe.cq.forms.core.components.models.form 2.1.0

      • getId

        @Nullable
default @Nullable java.lang.String getId()
        Returns a unique identifier
        Specified by:
        getId in interface Component
        Returns:
        unique identifier
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getFieldType

        default java.lang.String getFieldType()
        Description copied from interface: FormComponent
        Returns the field type
        Specified by:
        getFieldType in interface FormComponent
        Returns:
        the field type

      • isEnabled

        default java.lang.Boolean isEnabled()
        Description copied from interface: Base
        Returns true if form field should be enabled, otherwise false.
        Specified by:
        isEnabled in interface Base
        Returns:
        true if form field should be enabled, otherwise false

      • getIsHamburgerMenuEnabled

        default java.lang.Boolean getIsHamburgerMenuEnabled()
        Returns the hamburger menu support
        Returns:
        the hamburger menu support of the form
        Since:
        com.adobe.cq.forms.core.components.models.form 5.7.5

      • getLabel

        default Label getLabel()
        Description copied from interface: Base
        Returns label of the form field
        Specified by:
        getLabel in interface Base
        Returns:
        label of the field

      • isVisible

        default java.lang.Boolean isVisible()
        Description copied from interface: FormComponent
        Returns true if form field should be visible, otherwise false.
        Specified by:
        isVisible in interface FormComponent
        Returns:
        true if form field should be visible, otherwise false

      • getName

        default java.lang.String getName()
        Description copied from interface: FormComponent
        Returns the name of the form field
        Specified by:
        getName in interface FormComponent
        Returns:
        name of the form field

      • getTitle

        default java.lang.String getTitle()
        Returns the form title
        Returns:
        form title
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getDescription

        default java.lang.String getDescription()
        Returns the form description
        Specified by:
        getDescription in interface Base
        Returns:
        form description
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getModel

        default java.util.Map<java.lang.String,​java.lang.Object> getModel()
        Returns the form model
        Returns:
        the form model, based on the document path configured or the items
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getDocumentPath

        default java.lang.String getDocumentPath()
        Returns the document path (dam asset) containing the form model json
        Returns:
        the document path containing form model json, if one was set, or null
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getEncodedCurrentPagePath

        @Nullable
@Nullable java.lang.String getEncodedCurrentPagePath()
        Returns base64 encoded current page path
        Returns:
        base64 encoded current page path
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getThankYouMessage

        java.lang.String getThankYouMessage()
        Returns the form thank you message
        Returns:
        form thank you message
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getThankYouPage

        default java.lang.String getThankYouPage()
        Returns the form thank you page
        Returns:
        form thank you page
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getThankYouOption

        default ThankYouOption getThankYouOption()
        Returns the form thank you option
        Returns:
        form thank you option
        Since:
        com.adobe.cq.forms.core.components.models.form 4.4.0

      • getFormData

        default java.lang.String getFormData()
        Returns the form data
        Returns:
        the form data
        Since:
        com.adobe.cq.forms.core.components.models.form 0.0.1

      • getAction

        default java.lang.String getAction()
        Returns the submit action
        Returns:
        the submit action
        Since:
        com.adobe.cq.forms.core.components.models.form 4.0.0

      • getDataUrl

        default java.lang.String getDataUrl()
        Returns the data url to fetch form data
        Returns:
        the data url to fetch form data
        Since:
        com.adobe.cq.forms.core.components.models.form 4.0.0

      • getLang

        default java.lang.String getLang()
        Returns the language in which the form was authored
        Specified by:
        getLang in interface Base
        Returns:
        the language of the form
        Since:
        com.adobe.cq.forms.core.components.models.form 4.0.0

      • getContainingPageLang

        default java.lang.String getContainingPageLang()
        Returns the language of the containing page
        Returns:
        the language of the containing page
        Since:
        com.adobe.cq.forms.core.components.models.form 4.7.1

      • getLanguageDirection

        default java.lang.String getLanguageDirection()
        API to give direction of content in HTML for a given language.
        Returns:
        one of the constants "rtl" or "ltr" depending on direction of given language
        Since:
        com.adobe.cq.forms.core.components.models.form 4.5.0

      • getRedirectUrl

        default java.lang.String getRedirectUrl()
        Returns the redirect url after form submission
        Returns:
        the redirect url of the form
        Since:
        com.adobe.cq.forms.core.components.models.form 4.4.0

      • getPrefillService

        default java.lang.String getPrefillService()
        Returns the prefill service for the form
        Returns:
        the prefill service
        Since:
        com.adobe.cq.forms.core.components.models.form 4.4.0

      • setContextPath

        default void setContextPath​(java.lang.String contextPath)
        Set the contextPath in formContainer
        Since:
        com.adobe.cq.forms.core.components.models.form 4.4.0

      • visit

        default void visit​(java.util.function.Consumer<com.adobe.cq.export.json.ComponentExporter> callback)
            throws java.lang.Exception
        Throws:
        java.lang.Exception

      • getParentPagePath

        default java.lang.String getParentPagePath()
        Returns site page path if dropped in sites else the form page path.
        Returns:
        parent page path before jcr:content
        Since:
        com.adobe.cq.forms.core.components.models.form 4.4.0

      • getCustomFunctionUrl

        default java.lang.String getCustomFunctionUrl()
        Returns the url from where the custom functions should be registered
        Returns:
        custom function registration url
        Since:
        com.adobe.cq.forms.core.components.models.form 5.9.5

      • getAutoSaveConfig

        default AutoSaveConfiguration getAutoSaveConfig()
        Returns the auto save configuration
        Returns:
        auto save configuration
        Since:
        com.adobe.cq.forms.core.components.models.form 5.11.0