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

Interface Field

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PN_NAME
      Name of the property which holds the name of the field.

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default @NotNull java.lang.String getExportedType()
      Returns the type of the resource for which the export is performed.
      default java.lang.String getHelpMessage()
      Returns the message for the help block.
      default java.lang.String getId()
      Returns an unique identifier for this field.
      default java.lang.String getName()
      Returns the value of the HTML name attribute.
      default java.lang.String getTitle()
      Returns the title of the field (text displayed on the field).
      default java.lang.String getValue()
      Returns the value of the HTML value attribute.

    • Field Detail

      • PN_NAME

        static final java.lang.String PN_NAME
        Name of the property which holds the name of the field.
        Since:
        com.adobe.cq.wcm.core.components.models.form 14.5.0
        See Also:
        Constant Field Values

    • Method Detail

      • getId

        default java.lang.String getId()
        Returns an unique identifier for this field.
        Returns:
        an unique identifier for the field
        Since:
        com.adobe.cq.wcm.core.components.models.form 13.0.0; marked default in 14.1.0

      • getName

        default java.lang.String getName()
        Returns the value of the HTML name attribute.
        Returns:
        the value of the HTML name attribute

        Note: {'name':'value'} is sent as a request parameter when POST-ing the form

        Since:
        com.adobe.cq.wcm.core.components.models.form 13.0.0; marked default in 14.1.0

      • getValue

        default java.lang.String getValue()
        Returns the value of the HTML value attribute.
        Returns:
        the value of the HTML value attribute

        Note: {'name':'value'} is sent as a request parameter when POST-ing the form

        Since:
        com.adobe.cq.wcm.core.components.models.form 13.0.0; marked default in 14.1.0

      • getTitle

        default java.lang.String getTitle()
        Returns the title of the field (text displayed on the field).
        Returns:
        the title of the field (text displayed on the field)

        Implementations can return null if the title is not required.

        Since:
        com.adobe.cq.wcm.core.components.models.form 13.0.0; marked default in 14.1.0

      • getHelpMessage

        default java.lang.String getHelpMessage()
        Returns the message for the help block.
        Returns:
        the message for the help block

        Implementations can return null if the help message is not required.

        Since:
        com.adobe.cq.wcm.core.components.models.form 13.0.0; marked default in 14.1.0

      • getExportedType

        @NotNull
default @NotNull java.lang.String getExportedType()
        Description copied from interface: ComponentExporter

        Returns the type of the resource for which the export is performed.

        NOTE: methods whose JSON serialization would lead to the same JSON property name (":type") will not be serialized.

        Specified by:
        getExportedType in interface ComponentExporter
        Returns:
        the type of the component
        Since:
        com.adobe.cq.wcm.core.components.models.form 14.2.0
        See Also:
        ComponentExporter.getExportedType()