Interface FormFragment

    • Method Detail

      • setName

        void setName​(String name)
        Sets the name for this form field.
        Parameters:
        name - the new name
      • setIdentifier

        void setIdentifier​(String identifier)
        Sets the identifier for this form field.
        Parameters:
        identifier - the new identifier
      • getWmId

        WmId getWmId()
        Returns the WebManager ID (UUID) for this form fragment.
        Returns:
        the WebManager ID (UUID) for this form fragment
      • setPrecondition

        void setPrecondition​(String precondition)
        Sets the precondition that determines whether this form fragment should be displayed and handled. The precondition is a JavaScript expression that is evaluated within the scope of the formfragmentcontainer that contains this form fragment.
        Parameters:
        precondition - a boolean javascript expression
      • getLanguageContainers

        List<FormLanguageLabelContainer> getLanguageContainers()
        Returns the language label containers that hold translations of specific properties of this form fragment.
        Returns:
        the language label containers that hold translations of specific properties
      • setLanguageContainers

        void setLanguageContainers​(List<FormLanguageLabelContainer> containers)
        Sets the language label containers that hold translations of specific properties of this form fragment.
        Parameters:
        containers - the language label containers that hold translations of specific properties
      • getOrCreateLanguageContainer

        FormLanguageLabelContainer getOrCreateLanguageContainer​(String locale)
        Returns or creates a language label container for a specific locale
        Parameters:
        locale - the locale for which to return the language label container
        Returns:
        the language label container for the specified locale
      • getPrecondition

        String getPrecondition()
        Returns the precondition that determines whether to display and handle this form fragment. This is a boolean JavaScript expression evaluated within the context of the form fragment container in which this form fragment resides.
        Returns:
        the precondition that determines whether to display and handle this form fragment
      • getSimplePreConditionExpression

        SimpleExpression getSimplePreConditionExpression()
        Returns the precondition that determines whether to display and handle this form fragment. The precondition is of type SimpleExpression.
        Returns:
        the precondition that determines whether to display and handle this form fragment
      • setSimplePreConditionExpression

        void setSimplePreConditionExpression​(SimpleExpression expression)
        Returns the precondition that determines whether to display and handle this form fragment. The precondition is of type SimpleExpression.
        Parameters:
        expression - the precondition that determines whether to display and handle this form fragment
      • createSimplePreConditionExpression

        SimpleExpression createSimplePreConditionExpression()
        Creates a simple precondition expression for this form fragment.
        Returns:
        an empty SimpleExpression to be used as a precondition
      • deleteSimplePreConditionExpression

        void deleteSimplePreConditionExpression()
        Deletes the SimpleExpression precondition for this form fragment.
      • getPreconditionMode

        ConditionMode getPreconditionMode()
        Returns the mode in which to evaluate the precondition. See ConditionMode for more information.
        Returns:
        the mode in which to evaluate the precondition
      • setPreconditionMode

        void setPreconditionMode​(ConditionMode mode)
        Returns the mode in which to evaluate the precondition. See ConditionMode for more information.
        Parameters:
        mode - the mode in which to evaluate the precondition
      • getComponent

        FormFragmentComponent getComponent()
        Returns the form fragment component that declares the type of this form fragment.
        Returns:
        the FormFragmentComponent that declares the type of this form fragment
      • getDataFragmentTag

        String getDataFragmentTag()
        Returns the data-fragment-tag value of this form fragment property.
        Returns:
        the data-fragment-tag value of this form fragment property.
      • setDataFragmentTag

        void setDataFragmentTag​(String dataFragmentTag)
        Parameters:
        dataFragmentTag - - the data-fragment-tag value of this form fragment property.
      • getCssClassName

        String getCssClassName()
        Returns the css classname to be used while rendering this form fragment.
        Returns:
        the css classname to be used while rendering this form fragment
      • setCssClassName

        void setCssClassName​(String cssClassName)
        Returns the css classname to be used while rendering this form fragment.
        Parameters:
        cssClassName - the css classname to be used while rendering this form fragment
      • getDisplayLabel

        Boolean getDisplayLabel()
        Returns whether to display the label for this form fragment when rendering it.
        Returns:
        whether to display the label for this form fragment when rendering it
      • setDisplayLabel

        void setDisplayLabel​(Boolean displayLabel)
        Sets whether to display the label for this form fragment when rendering it.
        Parameters:
        displayLabel - whether to display the label for this form fragment when rendering it
      • hasVersionInLocale

        boolean hasVersionInLocale​(String locale)
        Returns if this form fragment is available in the specified locale.
        Parameters:
        locale - The locale to retrieve the information for
        Returns:
        true if this form fragment is available in the specified locale, false otherwise
        Since:
        10.33.0