Package io.wcm.handler.media.imagemap

Interface ImageMapArea

  • @ProviderType
public interface ImageMapArea
    Represents an image map area defined by the AEM image editor.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @Nullable java.lang.String getAltText()
      Returns the value for the alt attribute of the image map area.
      @NotNull java.lang.String getCoordinates()
      Returns the value for the coords attribute of the image map area.
      @Nullable java.lang.Object getLink()
      Returns link represent as link object
      @NotNull java.lang.String getLinkUrl()
      Returns the value for the href attribute of the image map area.
      @Nullable java.lang.String getLinkWindowTarget()
      Returns the value for the target attribute of the image map area.
      @Nullable java.lang.String getRelativeCoordinates()
      Returns the value for a relative unit representation of the coords attribute of the image map area.
      @NotNull java.lang.String getShape()
      Returns the value for the shape attribute of the image map area.

    • Method Detail

      • getShape

        @NotNull
@NotNull java.lang.String getShape()
        Returns the value for the shape attribute of the image map area.
        Returns:
        the image map area shape

      • getCoordinates

        @NotNull
@NotNull java.lang.String getCoordinates()
        Returns the value for the coords attribute of the image map area.
        Returns:
        the image map area coordinates

      • getRelativeCoordinates

        @Nullable
@Nullable java.lang.String getRelativeCoordinates()
        Returns the value for a relative unit representation of the coords attribute of the image map area.
        Returns:
        the image map area coordinates expressed in relative units

      • getLinkUrl

        @NotNull
@NotNull java.lang.String getLinkUrl()
        Returns the value for the href attribute of the image map area.
        Returns:
        the image map area link href

      • getLinkWindowTarget

        @Nullable
@Nullable java.lang.String getLinkWindowTarget()
        Returns the value for the target attribute of the image map area.
        Returns:
        the image map area link target

      • getAltText

        @Nullable
@Nullable java.lang.String getAltText()
        Returns the value for the alt attribute of the image map area.
        Returns:
        the image map area's alternative text

      • getLink

        @Nullable
@Nullable java.lang.Object getLink()
        Returns link represent as link object
        Returns:
        Link object (may be invalid)