All Superinterfaces:

Component, ComponentExporter
```
@ConsumerType
public interface Image
extends Component
```
Defines the Image Sling Model used for the /apps/core/wcm/components/image component.

Since:

com.adobe.cq.wcm.core.components.models 11.0.0

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_LAZY_ENABLED`	Deprecated. since 12.1.0
`static String`	`JSON_SMART_IMAGES`	Deprecated. since 12.1.0
`static String`	`JSON_SMART_SIZES`	Deprecated. since 12.1.0
`static String`	`PN_ALT_VALUE_FROM_DAM`	Name of the configuration policy property that will indicate if the value of the `alt` attribute should be populated from DAM if the component is configured with a file reference.
`static String`	`PN_ALT_VALUE_FROM_PAGE_IMAGE`	Name of the resource property that will indicate if the value of the `alt` attribute should be inherited from the featured image of the page.
`static String`	`PN_DESIGN_ALLOWED_RENDITION_WIDTHS`	Name of the configuration policy property that will store the allowed rendition widths for an image.
`static String`	`PN_DESIGN_DYNAMIC_MEDIA_ENABLED`	Name of the configuration policy property that controls whether Dynamic Media features are used by Core component.
`static String`	`PN_DESIGN_JPEG_QUALITY`	Name of the configuration policy property that will store the image quality for an image.
`static String`	`PN_DESIGN_LAZY_LOADING_ENABLED`	Name of the configuration policy property that will indicate if lazy loading should be disabled.
`static String`	`PN_DESIGN_LAZY_THRESHOLD`	Name of the configuration policy property that indicate the number of pixels, in advance of becoming visible, that a lazy loading image should load.
`static String`	`PN_DESIGN_RESIZE_WIDTH`	Name of the configuration policy property that will be used for resizing the base images, the ones from `src` attribute.
`static String`	`PN_DISPLAY_POPUP_TITLE`	Name of the resource property that will indicate if the image's caption will be rendered as a popup.
`static String`	`PN_FLIP_HORIZONTAL`	Name of the resource property that will indicate if the current image should be flipped horizontally.
`static String`	`PN_FLIP_VERTICAL`	Name of the resource property that will indicate if the current image should be flipped vertically.
`static String`	`PN_IMAGE_FROM_PAGE_IMAGE`	Name of the resource property that will indicate if the image is inherited from the featured image of the page.
`static String`	`PN_IMAGE_MODIFIERS`	Name of the resource property that will indicate if the current image should has Image Modifiers settings.
`static String`	`PN_IMAGE_SERVER_URL`	Name of the resource property that will indicate imageServerUrl.
`static String`	`PN_IS_DECORATIVE`	Name of the resource property that will indicate if the image is decorative.
`static String`	`PN_MAP`	Name of the resource property that defines areas of an image map.
`static String`	`PN_TITLE_VALUE_FROM_DAM`	Name of the configuration policy property that will indicate if the value of the `title` attribute should be populated from DAM if the component is configured with a file reference.
`static String`	`PN_UUID_DISABLED`	Name of the policy property that defines whether or not the UUID is disabled.

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

Method Summary

All Methods Instance Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`default boolean`	`displayPopupTitle()`	Checks if the image should display its caption as a popup (through the `<img>` `title` attribute).
`default String`	`getAlt()`	Returns the value for the `alt` attribute of the image.
`default List<ImageArea>`	`getAreas()`	Returns a list of image map areas.
`default ImageData`	`getComponentData()`
`default String`	`getFileReference()`	Returns the file reference of the current image, if one exists.
`default String`	`getHeight()`	Returns the height of the base DAM asset image, the one from the `src` attribute.
`default Link`	`getImageLink()`	Returns the image's link.
`default String`	`getJson()`	Deprecated. since 12.1.0
`default int`	`getLazyThreshold()`	Returns the number of pixels in advance of an image becoming visible that a lazy loading image should load.
`default String`	`getLink()`	Deprecated. Please use `getImageLink()`
`default String`	`getSmartCropRendition()`
`default String`	`getSrc()`	Returns the value for the `src` attribute of the image.
`default String`	`getSrcset()`	Returns the value for the `srcset` html attribute of the image.
`default String`	`getSrcUriTemplate()`	Returns a URI template representation of the image src attribute that can be variable expanded to a URI reference.
`default String`	`getTitle()`	Returns the value for the image's `title` attribute, if one was set.
`default String`	`getUuid()`	Returns the value for the image's uuid, if one was set.
`default String`	`getWidth()`	Returns the width of the base DAM asset image, the one from the `src` attribute.
`default @org.jetbrains.annotations.NotNull int[]`	`getWidths()`	Returns the alternative image widths (in pixels), configured through the `PN_DESIGN_ALLOWED_RENDITION_WIDTHS` content policy.
`default boolean`	`isDecorative()`	Indicates whether the image is decorative.
`default boolean`	`isDmImage()`
`default boolean`	`isLazyEnabled()`	Indicates if the image should be rendered lazily or not.

Methods inherited from interface com.adobe.cq.wcm.core.components.models.Component
getAppliedCssClasses, getData, getExportedType, getId

- Field Detail
  - PN_IMAGE_FROM_PAGE_IMAGE
```
static final String PN_IMAGE_FROM_PAGE_IMAGE
```
    Name of the resource property that will indicate if the image is inherited from the featured image of the page.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.23.0
    
    See Also:
    
    Constant Field Values
  - PN_ALT_VALUE_FROM_PAGE_IMAGE
```
static final String PN_ALT_VALUE_FROM_PAGE_IMAGE
```
    Name of the resource property that will indicate if the value of the alt attribute should be inherited from the featured image of the page.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.23.0
    
    See Also:
    
    Constant Field Values
  - PN_DESIGN_ALLOWED_RENDITION_WIDTHS
```
static final String PN_DESIGN_ALLOWED_RENDITION_WIDTHS
```
    Name of the configuration policy property that will store the allowed rendition widths for an image.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 11.0.0
    
    See Also:
    
    Constant Field Values
  - PN_DESIGN_JPEG_QUALITY
```
static final String PN_DESIGN_JPEG_QUALITY
```
    Name of the configuration policy property that will store the image quality for an image.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.5.0
    
    See Also:
    
    Constant Field Values
  - PN_DESIGN_LAZY_LOADING_ENABLED
```
static final String PN_DESIGN_LAZY_LOADING_ENABLED
```
    Name of the configuration policy property that will indicate if lazy loading should be disabled.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 11.0.0
    
    See Also:
    
    Constant Field Values
  - PN_DESIGN_LAZY_THRESHOLD
```
static final String PN_DESIGN_LAZY_THRESHOLD
```
    Name of the configuration policy property that indicate the number of pixels, in advance of becoming visible, that a lazy loading image should load.
    
    See Also:
    
    Constant Field Values
  - PN_IS_DECORATIVE
```
static final String PN_IS_DECORATIVE
```
    Name of the resource property that will indicate if the image is decorative.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 11.0.0
    
    See Also:
    
    Constant Field Values
  - PN_UUID_DISABLED
```
static final String PN_UUID_DISABLED
```
    Name of the policy property that defines whether or not the UUID is disabled.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.4.0
    
    See Also:
    
    Constant Field Values
  - PN_DISPLAY_POPUP_TITLE
```
static final String PN_DISPLAY_POPUP_TITLE
```
    Name of the resource property that will indicate if the image's caption will be rendered as a popup.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 11.0.0
    
    See Also:
    
    Constant Field Values
  - JSON_SMART_SIZES
```
@Deprecated
static final String JSON_SMART_SIZES
```
    Deprecated.
    since 12.1.0
    
    Name of the JSON property that will store the smart sizes for smart loading.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 11.0.0
    
    See Also:
    
    Constant Field Values
  - JSON_SMART_IMAGES
```
@Deprecated
static final String JSON_SMART_IMAGES
```
    Deprecated.
    since 12.1.0
    
    Name of the JSON property that will store the smart images for smart loading.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 11.0.0
    
    See Also:
    
    Constant Field Values
  - JSON_LAZY_ENABLED
```
@Deprecated
static final String JSON_LAZY_ENABLED
```
    Deprecated.
    since 12.1.0
    
    Name of the JSON property that will indicate if the image should be loaded lazily.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 11.0.0
    
    See Also:
    
    Constant Field Values
  - PN_ALT_VALUE_FROM_DAM
```
static final String PN_ALT_VALUE_FROM_DAM
```
    Name of the configuration policy property that will indicate if the value of the alt attribute should be populated from DAM if the component is configured with a file reference.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.2.0
    
    See Also:
    
    Constant Field Values
  - PN_TITLE_VALUE_FROM_DAM
```
static final String PN_TITLE_VALUE_FROM_DAM
```
    Name of the configuration policy property that will indicate if the value of the title attribute should be populated from DAM if the component is configured with a file reference.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.2.0
    
    See Also:
    
    Constant Field Values
  - PN_FLIP_HORIZONTAL
```
static final String PN_FLIP_HORIZONTAL
```
    Name of the resource property that will indicate if the current image should be flipped horizontally.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.3.0
    
    See Also:
    
    Constant Field Values
  - PN_FLIP_VERTICAL
```
static final String PN_FLIP_VERTICAL
```
    Name of the resource property that will indicate if the current image should be flipped vertically.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.3.0
    
    See Also:
    
    Constant Field Values
  - PN_IMAGE_MODIFIERS
```
static final String PN_IMAGE_MODIFIERS
```
    Name of the resource property that will indicate if the current image should has Image Modifiers settings.
    
    See Also:
    
    Constant Field Values
  - PN_IMAGE_SERVER_URL
```
static final String PN_IMAGE_SERVER_URL
```
    Name of the resource property that will indicate imageServerUrl.
    
    See Also:
    
    Constant Field Values
  - PN_MAP
```
static final String PN_MAP
```
    Name of the resource property that defines areas of an image map.
    The property stores map areas as follows: [area1][area2][...]
    Area format: [SHAPE(COORDINATES)"HREF"|"TARGET"|"ALT"|(RELATIVE_COORDINATES)]
    Example: [rect(0,0,10,10)"http://www.adobe.com"|"_self"|"alt"|(0,0,0.8,0.8)][circle(10,10,10)"http://www.adobe.com"|"_self"|"alt"|(0.8,0.8,0.8)]
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.4.0
    
    See Also:
    
    Constant Field Values
  - PN_DESIGN_DYNAMIC_MEDIA_ENABLED
```
static final String PN_DESIGN_DYNAMIC_MEDIA_ENABLED
```
    Name of the configuration policy property that controls whether Dynamic Media features are used by Core component.
    
    See Also:
    
    Constant Field Values
  - PN_DESIGN_RESIZE_WIDTH
```
static final String PN_DESIGN_RESIZE_WIDTH
```
    Name of the configuration policy property that will be used for resizing the base images, the ones from src attribute.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.23.0
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getSrc
```
default String getSrc()
```
    Returns the value for the src attribute of the image.
    
    Returns:
    
    the image's URL
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.1.0
  - getAlt
```
default 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
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.1.0
  - getTitle
```
default 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
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.1.0
  - getUuid
```
default 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
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.4.0;
  - getImageLink
```
default Link getImageLink()
```
    Returns the image's link.
    
    Returns:
    
    the image's link.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.20.0
  - getLink
```
@Deprecated
default String getLink()
```
    Deprecated.
    Please use getImageLink()
    
    Returns the image's link URL, if one was set.
    
    Returns:
    
    the image's link URL, if one was set, or null
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.1.0
  - displayPopupTitle
```
default 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
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.1.0
  - getFileReference
```
default 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
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.1.0
  - getJson
```
@Deprecated
default String getJson()
```
    Deprecated.
    since 12.1.0
    Returns a JSON object used for the smart image functionality. The object provides the following properties:
    
    JSON_SMART_SIZES - array of integers, representing the available image widths
    
    JSON_SMART_IMAGES - array of strings, providing the URLs for the available image renditions
    
    JSON_LAZY_ENABLED - boolean, specifying if the image should be rendered lazily or not
    Returns:
    
    the JSON for the smart image functionality
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 11.0.0; marked default in 12.1.0
  - getWidths
```
@NotNull
default @org.jetbrains.annotations.NotNull int[] getWidths()
```
    Returns the alternative image widths (in pixels), configured through the PN_DESIGN_ALLOWED_RENDITION_WIDTHS content policy. If no configuration is present, this method will return an empty array.
    
    Returns:
    
    the alternative image widths (in pixels)
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.2.0
  - getSrcUriTemplate
```
default String getSrcUriTemplate()
```
    Returns a URI template representation of the image src attribute that can be variable expanded to a URI reference. Useful for building an alternative image configuration from the original src.
    
    Returns:
    
    the image src URI template
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.2.0
  - isLazyEnabled
```
default boolean isLazyEnabled()
```
    Indicates if the image should be rendered lazily or not.
    
    Returns:
    
    true if the image should be rendered lazily; false otherwise
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.2.0
  - getSrcset
```
default String getSrcset()
```
    Returns the value for the srcset html attribute of the image.
    
    Returns:
    
    the value of the srcset attribute, if one was set, or null.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.21.0
  - getWidth
```
default String getWidth()
```
    Returns the width of the base DAM asset image, the one from the src attribute. It will be used as value for the width attribute of the image, only if the image is a DAM asset and is not SVG.
    
    Returns:
    
    the width of the base DAM asset image, the one from the src attribute.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.21.0;
  - getHeight
```
default String getHeight()
```
    Returns the height of the base DAM asset image, the one from the src attribute. It will be used as value for the height attribute of the image, only if the image is a DAM asset and is not SVG.
    
    Returns:
    
    the height of the base DAM asset image, the one from the src attribute.
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.21.0;
  - getLazyThreshold
```
default int getLazyThreshold()
```
    Returns the number of pixels in advance of an image becoming visible that a lazy loading image should load.
    
    Returns:
    
    The number of pixels.
  - getAreas
```
default List<ImageArea> getAreas()
```
    Returns a list of image map areas.
    
    Returns:
    
    the image map areas
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.4.0
  - isDecorative
```
default boolean isDecorative()
```
    Indicates whether the image is decorative.
    
    Returns:
    
    true if the image is decorative; false otherwise
    
    Since:
    
    com.adobe.cq.wcm.core.components.models 12.11.0
  - getSmartCropRendition
```
default String getSmartCropRendition()
```
  - isDmImage
```
default boolean isDmImage()
```
  - getComponentData
```
default ImageData getComponentData()
```

Interface Image

Field Summary

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

Method Summary

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

Field Detail

PN_IMAGE_FROM_PAGE_IMAGE

PN_ALT_VALUE_FROM_PAGE_IMAGE

PN_DESIGN_ALLOWED_RENDITION_WIDTHS

PN_DESIGN_JPEG_QUALITY

PN_DESIGN_LAZY_LOADING_ENABLED

PN_DESIGN_LAZY_THRESHOLD

PN_IS_DECORATIVE

PN_UUID_DISABLED

PN_DISPLAY_POPUP_TITLE

JSON_SMART_SIZES

JSON_SMART_IMAGES

JSON_LAZY_ENABLED

PN_ALT_VALUE_FROM_DAM

PN_TITLE_VALUE_FROM_DAM

PN_FLIP_HORIZONTAL

PN_FLIP_VERTICAL

PN_IMAGE_MODIFIERS

PN_IMAGE_SERVER_URL

PN_MAP

PN_DESIGN_DYNAMIC_MEDIA_ENABLED

PN_DESIGN_RESIZE_WIDTH

Method Detail

getSrc

getAlt

getTitle

getUuid

getImageLink

getLink

displayPopupTitle

getFileReference

getJson

getWidths

getSrcUriTemplate

isLazyEnabled

getSrcset

getWidth

getHeight

getLazyThreshold

getAreas

isDecorative

getSmartCropRendition

isDmImage

getComponentData