Package io.wcm.wcm.core.components.models

Interface ResponsiveImage

All Superinterfaces:
com.adobe.cq.wcm.core.components.models.Component, com.adobe.cq.export.json.ComponentExporter, LinkMixin, MediaMixin
@ConsumerType public interface ResponsiveImage extends com.adobe.cq.wcm.core.components.models.Component, com.adobe.cq.export.json.ComponentExporter, MediaMixin, LinkMixin
Defines the ResponsiveImage Sling Model used for the /apps/wcm-io/wcm/core/components/responsiveimage component.

  • Field Summary

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

    PN_ID

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    displayPopupTitle()
    Checks if the image should display its caption as a popup (through the <img> title attribute).
    @Nullable String
    getAlt()
    Returns the value for the alt attribute of the image.
    @Nullable List<com.adobe.cq.wcm.core.components.models.ImageArea>
    getAreas()
    Returns a list of image map areas.
    @Nullable String
    getFileReference()
    Returns the file reference of the current image, if one exists.
    @Nullable String
    getTitle()
    Returns the value for the image's title attribute, if one was set.
    @Nullable String
    getUuid()
    Returns the value for the image's uuid, if one was set.

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

    getAppliedCssClasses, getData, getExportedType, getId

    Methods inherited from interface io.wcm.wcm.core.components.models.mixin.LinkMixin

    getLinkAttributes, getLinkObject, getLinkURL, isLinkValid

    Methods inherited from interface io.wcm.wcm.core.components.models.mixin.MediaMixin

    getMediaMarkup, getMediaObject, getMediaURL, isMediaValid

  • Method Details

    • getAlt

      @Nullable @Nullable String getAlt()
      Returns the value for the alt attribute of the image.
      Returns:
      the value for the image's alt attribute, if one was set, or null

    • getTitle

      @Nullable @Nullable String getTitle()
      Returns the value for the image's title attribute, if one was set.
      Returns:
      the value for the image's title attribute, if one was set, or null

    • getUuid

      @Nullable @Nullable String getUuid()
      Returns the value for the image's uuid, if one was set.
      Returns:
      the value for the image's uuid, if one was set, or null

    • displayPopupTitle

      boolean displayPopupTitle()
      Checks if the image should display its caption as a popup (through the <img> title attribute).
      Returns:
      true if the caption should be displayed as a popup, false otherwise

    • getFileReference

      @Nullable @Nullable String getFileReference()
      Returns the file reference of the current image, if one exists.
      Returns:
      the file reference of the current image, if one exists, null otherwise

    • getAreas

      @Nullable @Nullable List<com.adobe.cq.wcm.core.components.models.ImageArea> getAreas()
      Returns a list of image map areas.
      Returns:
      the image map areas