Interface Link

  • All Superinterfaces:
    com.adobe.cq.wcm.core.components.models.Component, com.adobe.cq.export.json.ComponentExporter

    @ConsumerType
    public interface Link
    extends com.adobe.cq.wcm.core.components.models.Component
    Defines the sling model for /apps/core/fd/components/formsportal/link component.
    Since:
    com.adobe.cq.forms.core.components.models.aemform 1.0.0
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  Link.AssetType
      Defines the Asset Type that is being linked to
    • Field Summary

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

        PN_ID
    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default java.lang.String getAccessibilityLabel()
      Returns the accessibility label on corresponding link
      default java.lang.String getAssetPath()
      Returns path to the asset to which the URL would redirect to Note that this is not the url.
      default java.lang.String getAssetPathWithQueryParams()
      Returns url to which the component is linking to The URL contains query parameters if configured
      default Link.AssetType getAssetType()
      Return the asset type that is linked to
      default java.lang.String getTitle()
      Returns the text shown in Link
      default java.lang.String getTooltip()
      Return the text shown on hovering over link
      • Methods inherited from interface com.adobe.cq.wcm.core.components.models.Component

        getAppliedCssClasses, getData, getExportedType, getId
    • Method Detail

      • getAssetPathWithQueryParams

        default java.lang.String getAssetPathWithQueryParams()
        Returns url to which the component is linking to The URL contains query parameters if configured
        Returns:
        URL after processing, or # if none is set
        Since:
        com.adobe.cq.forms.core.components.models.formsportal 2.0.0
      • getTitle

        default java.lang.String getTitle()
        Returns the text shown in Link
        Returns:
        Title string. It is a mandatory field.
        Since:
        com.adobe.cq.forms.core.components.models.formsportal 1.0.0
      • getTooltip

        default java.lang.String getTooltip()
        Return the text shown on hovering over link
        Returns:
        Tooltip string. Can return null if not set
        Since:
        com.adobe.cq.forms.core.components.models.formsportal 1.0.0
      • getAssetType

        default Link.AssetType getAssetType()
        Return the asset type that is linked to
        Returns:
        Asset Type if set
        Since:
        com.adobe.cq.forms.core.components.models.formsportal 1.0.0
      • getAssetPath

        default java.lang.String getAssetPath()
        Returns path to the asset to which the URL would redirect to Note that this is not the url. For url, use getAssetPathWithQueryParams()
        Returns:
        Path to asset if configured
        Since:
        com.adobe.cq.forms.core.components.models.formsportal 1.0.0
      • getAccessibilityLabel

        default java.lang.String getAccessibilityLabel()
        Returns the accessibility label on corresponding link
        Returns:
        accessibility label
        Since:
        com.adobe.cq.forms.core.components.models.formsportal 2.1.0