@ConsumerType public interface Image extends Component
Image
Sling Model used for the /apps/core/wcm/components/image
component.Modifier and Type | Field and 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_DESIGN_ALLOWED_RENDITION_WIDTHS
Name of the configuration policy property that will store the allowed rendition widths for an image.
|
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_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_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.
|
Modifier and Type | Method and 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 @NotNull String |
getExportedType()
Returns the type of the resource for which the export is performed.
|
default String |
getFileReference()
Returns the file reference of the current image, if one exists.
|
default String |
getJson()
Deprecated.
since 12.1.0
|
default String |
getLink()
Returns the image's link URL, if one was set.
|
default String |
getSrc()
Returns the value for the
src 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 @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 |
isLazyEnabled()
Indicates if the image should be rendered lazily or not.
|
static final String PN_DESIGN_ALLOWED_RENDITION_WIDTHS
static final String PN_DESIGN_JPEG_QUALITY
static final String PN_DESIGN_LAZY_LOADING_ENABLED
static final String PN_IS_DECORATIVE
static final String PN_UUID_DISABLED
static final String PN_DISPLAY_POPUP_TITLE
@Deprecated static final String JSON_SMART_SIZES
@Deprecated static final String JSON_SMART_IMAGES
@Deprecated static final String JSON_LAZY_ENABLED
static final String PN_ALT_VALUE_FROM_DAM
alt
attribute should be populated from
DAM if the component is configured with a file reference.static final String PN_TITLE_VALUE_FROM_DAM
title
attribute should be populated from
DAM if the component is configured with a file reference.static final String PN_FLIP_HORIZONTAL
static final String PN_FLIP_VERTICAL
static final String PN_MAP
default String getSrc()
src
attribute of the image.default
in 12.1.0default String getAlt()
alt
attribute of the image.alt
attribute, if one was set, or null
default
in 12.1.0default String getTitle()
title
attribute, if one was set.title
attribute, if one was set, or null
default
in 12.1.0default String getUuid()
null
default String getLink()
null
default
in 12.1.0default boolean displayPopupTitle()
<img>
title
attribute).true
if the caption should be displayed as a popup, false
otherwisedefault
in 12.1.0default String getFileReference()
null
otherwisedefault
in 12.1.0@Deprecated default String getJson()
JSON_SMART_SIZES
- array of integers, representing the available image widthsJSON_SMART_IMAGES
- array of strings, providing the URLs for the available image renditionsJSON_LAZY_ENABLED
- boolean, specifying if the image should be rendered lazily or notdefault
in 12.1.0@NotNull default @NotNull int[] getWidths()
PN_DESIGN_ALLOWED_RENDITION_WIDTHS
content policy. If no configuration is present, this method will return an empty array.default String getSrcUriTemplate()
default boolean isLazyEnabled()
default List<ImageArea> getAreas()
@NotNull default @NotNull String getExportedType()
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.
getExportedType
in interface Component
getExportedType
in interface ComponentExporter
ComponentExporter.getExportedType()
default boolean isDecorative()
Copyright © 2010 - 2020 Adobe. All Rights Reserved