Index

A B C D E F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractImageMediaMarkupBuilder - Class in io.wcm.handler.media.markup

Shared functionality for MediaMarkupBuilder image implementations.

AbstractImageMediaMarkupBuilder() - Constructor for class io.wcm.handler.media.markup.AbstractImageMediaMarkupBuilder

accepts(Media) - Method in class io.wcm.handler.media.markup.DummyImageMediaMarkupBuilder

accepts(Media) - Method in class io.wcm.handler.media.markup.SimpleImageMediaMarkupBuilder

accepts(Media) - Method in interface io.wcm.handler.media.spi.MediaMarkupBuilder

Checks whether this builder can generate markup for the given media.

accepts(Media) - Method in class io.wcm.handler.mediasource.dam.markup.DamVideoMediaMarkupBuilder

accepts(MediaRequest) - Method in class io.wcm.handler.media.spi.MediaSource

Checks whether a media request can be handled by this media source

accepts(MediaRequest) - Method in class io.wcm.handler.mediasource.inline.InlineMediaSource

accepts(String) - Method in class io.wcm.handler.media.spi.MediaSource

Checks whether a media request string can be handled by this media source

accepts(String) - Method in class io.wcm.handler.mediasource.dam.DamMediaSource

accepts(String) - Method in class io.wcm.handler.mediasource.inline.InlineMediaSource

accepts(String) - Method in class io.wcm.handler.mediasource.ngdm.NextGenDynamicMediaMediaSource

addDiffDecoration(HtmlElement, Resource, String, SlingHttpServletRequest, MediaHandlerConfig) - Static method in class io.wcm.handler.media.markup.MediaMarkupBuilderUtil

Adds CSS classes that denote the changes to the media element when compared to a different version.

addSources(Video, Media) - Method in class io.wcm.handler.mediasource.dam.markup.DamVideoMediaMarkupBuilder

Add sources for HTML5 video player

AemRenditionType - Enum Class in io.wcm.handler.mediasource.dam

Defines the different types of renditions generated automatically by AEM.

allowedIpeEditorTypes() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Get allowed IPE editor types.

altText(String) - Method in interface io.wcm.handler.media.MediaBuilder

Allows to specify a custom alternative text that is to be used instead of the one defined in the the asset metadata.

altText(String) - Method in class io.wcm.handler.media.MediaArgs

Allows to specify a custom alternative text that is to be used instead of the one defined in the the asset metadata.

ALWAYS - Enum constant in enum class io.wcm.handler.media.markup.DragDropSupport

Always apply drag&drop support (if the media markup builder and media source implemention permit it).

ALWAYS - Enum constant in enum class io.wcm.handler.media.markup.IPERatioCustomize

Always set customized cropping ratios, overwriting any existing ones.

applyImageMap(HtmlElement, Media) - Method in class io.wcm.handler.media.markup.SimpleImageMediaMarkupBuilder

If a image map was resolved apply map markup to given image element.

applyWcmMarkup(HtmlElement, Media) - Method in class io.wcm.handler.media.markup.AbstractImageMediaMarkupBuilder

Apply Markup for Drag&Drop mode and Diff decoration in WCM edit/preview mode.

args(MediaArgs) - Method in interface io.wcm.handler.media.MediaBuilder

Sets additional arguments affection media resolving e.g. media formats.

Asset - Interface in io.wcm.handler.media

Represents a media item that is referenced via a MediaRequest and resolved via MediaHandler.

AssetRendition - Class in io.wcm.handler.mediasource.dam

Helper methods for getting metadata for DAM renditions.

AUTO - Enum constant in enum class io.wcm.handler.media.markup.DragDropSupport

Check via heuristics if drag&drop should be supported.

AUTO - Enum constant in enum class io.wcm.handler.media.markup.IPERatioCustomize

Set customized cropping ratios only when non are defined for the component.

autoCrop(boolean) - Method in class io.wcm.handler.media.MediaArgs

Enable or disable auto-cropping mode.

autoCrop(boolean) - Method in interface io.wcm.handler.media.MediaBuilder

Enable or disable auto-cropping mode.

B

build() - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Builds the media format definition.

build() - Method in interface io.wcm.handler.media.MediaBuilder

Resolve media and return metadata objects that contains all results.

build(Media) - Method in class io.wcm.handler.media.markup.DummyImageMediaMarkupBuilder

build(Media) - Method in class io.wcm.handler.media.markup.SimpleImageMediaMarkupBuilder

build(Media) - Method in interface io.wcm.handler.media.spi.MediaMarkupBuilder

Build media element markup

build(Media) - Method in class io.wcm.handler.mediasource.dam.markup.DamVideoMediaMarkupBuilder

buildElement() - Method in interface io.wcm.handler.media.MediaBuilder

Resolve media and return directly the markup as DOM element generated by the media markup builder.

buildImageMapName(List<ImageMapArea>, Media) - Method in class io.wcm.handler.media.markup.SimpleImageMediaMarkupBuilder

Builds an ID for the image map that is unique within the page.

buildMarkup() - Method in interface io.wcm.handler.media.MediaBuilder

Resolve media and return directly the markup generated by the media markup builder.

buildUrl() - Method in interface io.wcm.handler.media.MediaBuilder

Resolve media and get URL to reference it directly.

C

canApplyDragDropSupport(MediaRequest, ComponentContext) - Static method in class io.wcm.handler.media.markup.MediaMarkupBuilderUtil

Implements check whether to apply drag&drop support as described in DragDropSupport.

canSetCustomIPECropRatios(MediaRequest, ComponentContext) - Static method in class io.wcm.handler.media.markup.MediaMarkupBuilderUtil

Implements check whether to set customized IPE cropping ratios as described in IPERatioCustomize.

canSetCustomIPECropRatios(MediaRequest, ComponentContext, Set<String>) - Static method in class io.wcm.handler.media.markup.MediaMarkupBuilderUtil

Implements check whether to set customized IPE cropping ratios as described in IPERatioCustomize.

clone() - Method in class io.wcm.handler.media.MediaArgs

Custom clone-method for MediaArgs

close() - Method in class io.wcm.handler.media.MediaComponentPropertyResolver

compare(MediaFormat, MediaFormat) - Method in class io.wcm.handler.media.format.MediaFormatCombinedTitleComparator

compare(MediaFormat, MediaFormat) - Method in class io.wcm.handler.media.format.MediaFormatRankingComparator

compare(MediaFormat, MediaFormat) - Method in class io.wcm.handler.media.format.MediaFormatSizeRankingComparator

compareTo(MediaFormat) - Method in class io.wcm.handler.media.format.MediaFormat

contentDispositionAttachment(boolean) - Method in class io.wcm.handler.media.MediaArgs

Set whether Content-Disposition header should be set to attachment.

contentDispositionAttachment(boolean) - Method in interface io.wcm.handler.media.MediaBuilder

Set whether Content-Disposition header should be set to attachment.

create(String) - Static method in class io.wcm.handler.media.format.MediaFormatBuilder

Create a new media format builder.

CROP_CENTER - Enum constant in enum class io.wcm.handler.media.UriTemplateType

URI template for building an asset rendition with {width} and {height} parameter, cropping the original image if required to it's central part to fit into the given box.

CropDimension - Class in io.wcm.handler.media

Crop dimension with left, top, width and height as integer.

CropDimension(long, long, long, long) - Constructor for class io.wcm.handler.media.CropDimension

Create crop dimension.

CropDimension(long, long, long, long, boolean) - Constructor for class io.wcm.handler.media.CropDimension

Create crop dimension with auto-crop flag.

cropProperty(String) - Method in interface io.wcm.handler.media.MediaBuilder

Set the name of the property which contains the cropping parameters.

cropProperty(String) - Method in class io.wcm.handler.media.MediaRequest.MediaPropertyNames

Set cropping property name.

CSS_DIFF_ADDED - Static variable in class io.wcm.handler.media.MediaNameConstants

CSS class for "Added in Diff Mode"

CSS_DIFF_REMOVED - Static variable in class io.wcm.handler.media.MediaNameConstants

CSS class for "Removed in Diff Mode"

CSS_DIFF_UPDATED - Static variable in class io.wcm.handler.media.MediaNameConstants

CSS class for "Updated in Diff Mode"

CSS_DUMMYIMAGE - Static variable in class io.wcm.handler.media.MediaNameConstants

CSS class for dummy image

CUSTOM - Enum constant in enum class io.wcm.handler.media.MediaInvalidReason

Media is invalid due to a check from a pre- or post processor.

D

DamMediaSource - Class in io.wcm.handler.mediasource.dam

Default implementation for media requests to media items stored in AEM Assets (DAM).

DamMediaSource() - Constructor for class io.wcm.handler.mediasource.dam.DamMediaSource

DamVideoMediaMarkupBuilder - Class in io.wcm.handler.mediasource.dam.markup

Default implementation of MediaMarkupBuilder for DAM video assets.

DamVideoMediaMarkupBuilder() - Constructor for class io.wcm.handler.mediasource.dam.markup.DamVideoMediaMarkupBuilder

decorative(boolean) - Method in class io.wcm.handler.media.MediaArgs

Set whether image is decorative.

decorative(boolean) - Method in interface io.wcm.handler.media.MediaBuilder

Set whether image is decorative.

DEFAULT_ALLOWED_IPE_EDITOR_TYPES - Static variable in class io.wcm.handler.media.markup.MediaMarkupBuilderUtil

List of OOTB IPE editor types for images.

DEFAULT_IMAGE_QUALITY - Static variable in class io.wcm.handler.media.spi.MediaHandlerConfig

Default image quality for images with lossy compressions (e.g.

DEFAULT_JPEG_QUALITY - Static variable in class io.wcm.handler.media.spi.MediaHandlerConfig

Deprecated.

Use MediaHandlerConfig.DEFAULT_IMAGE_QUALITY instead.

description(String) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set description for displaying to user.

detectMediaFormat(String, long, long, long) - Method in interface io.wcm.handler.media.format.MediaFormatHandler

Detect matching media format.

detectMediaFormats(String, long, long, long) - Method in interface io.wcm.handler.media.format.MediaFormatHandler

Detect all matching media formats.

Dimension - Class in io.wcm.handler.media

Dimension with width and height as integer.

Dimension(long, long) - Constructor for class io.wcm.handler.media.Dimension

Create dimension with width and height.

download(boolean) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set whether media assets should be downloaded.

download(boolean) - Method in class io.wcm.handler.media.MediaArgs

Set whether to accept only download media formats.

dragDropSupport(DragDropSupport) - Method in class io.wcm.handler.media.MediaArgs

Drag&Drop support for media builder.

dragDropSupport(DragDropSupport) - Method in interface io.wcm.handler.media.MediaBuilder

Drag&Drop support for media builder.

DragDropSupport - Enum Class in io.wcm.handler.media.markup

Controls whether the markup builder should apply drag&drop support for the rendered markup.

DUMMY_IMAGE - Static variable in interface io.wcm.handler.media.spi.MediaMarkupBuilder

Dummy image

DUMMY_MIN_DIMENSION - Static variable in interface io.wcm.handler.media.spi.MediaMarkupBuilder

Try to render dummy image with least with this dimension.

dummyImage(boolean) - Method in class io.wcm.handler.media.MediaArgs

Set whether dummy image is enabled.

dummyImage(boolean) - Method in interface io.wcm.handler.media.MediaBuilder

Set whether dummy image is enabled.

DummyImageMediaMarkupBuilder - Class in io.wcm.handler.media.markup

Generates a simple dummy image as edit placeholder in WCM edit mode, if no media item is set.

DummyImageMediaMarkupBuilder() - Constructor for class io.wcm.handler.media.markup.DummyImageMediaMarkupBuilder

dummyImageUrl(String) - Method in interface io.wcm.handler.media.MediaBuilder

Set URL of custom dummy image.

dummyImageUrl(String) - Method in class io.wcm.handler.media.MediaArgs

Set URL of custom dummy image.

dynamicMediaDisabled(boolean) - Method in class io.wcm.handler.media.MediaArgs

Set whether dynamic media support is disabled.

dynamicMediaDisabled(boolean) - Method in interface io.wcm.handler.media.MediaBuilder

Disable dynamic media support.

E

enableMediaDrop(HtmlElement, MediaRequest) - Method in class io.wcm.handler.media.spi.MediaSource

Create a drop area for given HTML element to enable drag and drop of DAM assets from content finder to this element.

enableMediaDrop(HtmlElement, MediaRequest) - Method in class io.wcm.handler.mediasource.dam.DamMediaSource

enableMediaDrop(HtmlElement, MediaRequest) - Method in class io.wcm.handler.mediasource.inline.InlineMediaSource

enableMediaDrop(HtmlElement, MediaRequest) - Method in class io.wcm.handler.mediasource.ngdm.NextGenDynamicMediaMediaSource

enforceOutputFileExtension(String) - Method in interface io.wcm.handler.media.MediaBuilder

Enforces image file type for renditions.

enforceOutputFileExtension(String) - Method in class io.wcm.handler.media.MediaArgs

Enforces image file type for renditions.

enforceVirtualRenditions() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Enforce to generate only virtual renditions.

equals(Object) - Method in class io.wcm.handler.media.CropDimension

equals(Object) - Method in class io.wcm.handler.media.Dimension

equals(Object) - Method in class io.wcm.handler.media.format.MediaFormat

equals(Object) - Method in class io.wcm.handler.media.MediaArgs

equals(Object) - Method in class io.wcm.handler.media.MediaArgs.ImageSizes

equals(Object) - Method in class io.wcm.handler.media.MediaArgs.MediaFormatOption

equals(Object) - Method in class io.wcm.handler.media.MediaArgs.PictureSource

equals(Object) - Method in class io.wcm.handler.media.MediaArgs.WidthOption

extensions(String...) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set allowed file extensions.

F

fileExtension(String) - Method in interface io.wcm.handler.media.MediaBuilder

Set accepted file extension.

fileExtension(String) - Method in class io.wcm.handler.media.MediaArgs

Set accepted file extension.

fileExtensions(String...) - Method in interface io.wcm.handler.media.MediaBuilder

Set accepted file extensions.

fileExtensions(String...) - Method in class io.wcm.handler.media.MediaArgs

Set accepted file extensions.

fileSizeMax(long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set maximum file size.

finalize() - Method in class io.wcm.handler.media.spi.MediaFormatProvider

Deprecated.

Prevent finalize attack (PMD CT_CONSTRUCTOR_THROW / SEI CERT Rule OBJ-11)

fixedDimension(long, long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set fixed width and height dimensions.

fixedDimension(long, long) - Method in class io.wcm.handler.media.MediaArgs

Use fixed dimensions instead of width from media format or original image

fixedDimension(long, long) - Method in interface io.wcm.handler.media.MediaBuilder

Use fixed dimensions instead of width from media format or original image

fixedHeight(long) - Method in class io.wcm.handler.media.MediaArgs

Use fixed height instead of width from media format or original image

fixedHeight(long) - Method in interface io.wcm.handler.media.MediaBuilder

Use fixed height instead of width from media format or original image

fixedWidth(long) - Method in class io.wcm.handler.media.MediaArgs

Use fixed width instead of width from media format or original image

fixedWidth(long) - Method in interface io.wcm.handler.media.MediaBuilder

Use fixed width instead of width from media format or original image

forceAltValueFromAsset(boolean) - Method in class io.wcm.handler.media.MediaArgs

Set whether to force alt text from DAM asset description.

forceAltValueFromAsset(boolean) - Method in interface io.wcm.handler.media.MediaBuilder

Set whether to force alt text from DAM asset description.

forRendition(Rendition) - Static method in enum class io.wcm.handler.mediasource.dam.AemRenditionType

Get matching AEM rendition type for given rendition.

forRendition(String) - Static method in enum class io.wcm.handler.mediasource.dam.AemRenditionType

Get matching AEM rendition type for given rendition name.

fromCropString(String) - Static method in class io.wcm.handler.media.CropDimension

Get crop dimension from crop string.

G

get(double, double) - Static method in class io.wcm.handler.media.format.Ratio

Get ratio from width/height.

get(long, long) - Static method in class io.wcm.handler.media.format.Ratio

Get ratio from width/height.

get(Dimension) - Static method in class io.wcm.handler.media.format.Ratio

Get ratio from width/height.

get(MediaRequest) - Method in interface io.wcm.handler.media.MediaHandler

Build media for the given request holding all further request properties.

get(String) - Method in interface io.wcm.handler.media.MediaHandler

Build media which is referenced via its string address.

get(String, MediaArgs) - Method in interface io.wcm.handler.media.MediaHandler

Build media which is referenced via its string address.

get(String, MediaFormat...) - Method in interface io.wcm.handler.media.MediaHandler

Build media which is referenced via its string address.

get(String, Resource) - Method in interface io.wcm.handler.media.MediaHandler

Build media which is referenced via its string address.

get(Resource) - Method in interface io.wcm.handler.media.MediaHandler

Build media which is referenced in the resource (as property or inline binary data).

get(Resource, MediaArgs) - Method in interface io.wcm.handler.media.MediaHandler

Build media which is referenced in the resource (as property or inline binary data).

get(Resource, MediaFormat...) - Method in interface io.wcm.handler.media.MediaHandler

Build media which is referenced in the resource (as property or inline binary data).

getAdditionalFlashPlayerFlashVars(Media, Dimension) - Method in class io.wcm.handler.mediasource.dam.markup.DamVideoMediaMarkupBuilder

Get additional parameters to be set as flashvars parameter on html object element for flash player.

getAdditionalFlashPlayerParameters(Media, Dimension) - Method in class io.wcm.handler.mediasource.dam.markup.DamVideoMediaMarkupBuilder

Get additional parameters to be set as <param> elements on html object element for flash player.

getAllMediaFormats() - Method in interface io.wcm.handler.media.format.MediaFormatProviderManager

Get all media format definitions deployed in the system, grouped by bundle which exposes them.

getAltText() - Method in interface io.wcm.handler.media.Asset

Get alternative text for media item.

getAltText() - Method in interface io.wcm.handler.media.imagemap.ImageMapArea

Returns the value for the alt attribute of the image map area.

getAltText() - Method in class io.wcm.handler.media.MediaArgs

Get custom alternative text.

getAsset() - Method in class io.wcm.handler.media.Media

Get media item info that was resolved during media handler processing

getAssetSelectorsJsUrl() - Method in class io.wcm.handler.mediasource.ngdm.NextGenDynamicMediaConfigModel

Get Asset Selectors JavaScript URL.

getBottom() - Method in class io.wcm.handler.media.CropDimension

Get bottom coordinate in pixels.

getBrowserImageContentTypes() - Static method in enum class io.wcm.handler.media.MediaFileType

Get browser-supported image content types.

getBrowserImageFileExtensions() - Static method in enum class io.wcm.handler.media.MediaFileType

Get browser-supported image file extensions.

getByContentType(String) - Static method in enum class io.wcm.handler.media.MediaFileType

Get Media file type by content type.

getByFileExtensions(String) - Static method in enum class io.wcm.handler.media.MediaFileType

Get Media file type by file extension.

getClassAppend() - Method in class io.wcm.handler.media.ui.MediaPlaceholder

Gets additional CSS classes for the replacement placeholder to allow drag&drop of assets into an empty component.

getConfigJson() - Method in class io.wcm.handler.mediasource.ngdm.NextGenDynamicMediaConfigModel

Get client-side configuration JSON.

getContentTypes() - Method in enum class io.wcm.handler.media.MediaFileType

Get content types for this media file type.

getCoordinates() - Method in interface io.wcm.handler.media.imagemap.ImageMapArea

Returns the value for the coords attribute of the image map area.

getCropDimension() - Method in class io.wcm.handler.media.Media

Get crop dimensions.

getCropProperty() - Method in class io.wcm.handler.media.MediaRequest.MediaPropertyNames

Get cropping property name.

getCropString() - Method in class io.wcm.handler.media.CropDimension

Get crop string with coordinates.

getCropStringWidthHeight() - Method in class io.wcm.handler.media.CropDimension

Get crop string with dimensions.

getDamAsset(Media) - Method in class io.wcm.handler.mediasource.dam.markup.DamVideoMediaMarkupBuilder

Get DAM asset from media metadata.

getDamRootPath(Page) - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Get root path for picking assets using path field widgets.

getDefaultImageQuality(String) - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Get the default quality for images.

getDefaultImageQualityPercentage() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Get the default quality for images.

getDefaultRendition() - Method in interface io.wcm.handler.media.Asset

Get the default rendition without specifying and media args.

getDensity() - Method in class io.wcm.handler.media.MediaArgs.WidthOption

Get density descriptor.

getDensityDescriptor() - Method in class io.wcm.handler.media.MediaArgs.WidthOption

Get density descriptor or empty string.

getDescription() - Method in interface io.wcm.handler.media.Asset

Get description for this media item.

getDescription() - Method in class io.wcm.handler.media.format.MediaFormat

Get media format description.

getDimension(Rendition) - Static method in class io.wcm.handler.mediasource.dam.AssetRendition

Get dimension (width, height) of given DAM rendition.

getDimension(Rendition, boolean) - Static method in class io.wcm.handler.mediasource.dam.AssetRendition

Get dimension (width, height) of given DAM rendition.

getDownloadRendition(MediaArgs) - Method in interface io.wcm.handler.media.Asset

Get the first download rendition that matches the given media args.

getDragDropSupport() - Method in class io.wcm.handler.media.MediaArgs

Drag&Drop support for media builder.

getDummyImageUrl() - Method in class io.wcm.handler.media.MediaArgs

Get URL of custom dummy image.

getEffectiveMaxHeight() - Method in class io.wcm.handler.media.format.MediaFormat

Get effective maximum image height.

getEffectiveMaxWidth() - Method in class io.wcm.handler.media.format.MediaFormat

Get effective maximum image width.

getEffectiveMinHeight() - Method in class io.wcm.handler.media.format.MediaFormat

Get effective minimum image height.

getEffectiveMinWidth() - Method in class io.wcm.handler.media.format.MediaFormat

Get effective minimum image width.

getElement() - Method in class io.wcm.handler.media.Media

Get HTML element.

getEnforceOutputFileExtension() - Method in class io.wcm.handler.media.MediaArgs

Enforces image file type for renditions.

getExtensions() - Method in class io.wcm.handler.media.format.MediaFormat

Get allowed file extensions.

getExtensions() - Method in enum class io.wcm.handler.media.MediaFileType

Get file extensions for this media file type.

getFileExtension() - Method in interface io.wcm.handler.media.Rendition

Get file extension of rendition.

getFileExtensions() - Method in class io.wcm.handler.media.MediaArgs

Get accepted file extensions.

getFilename(Rendition) - Static method in class io.wcm.handler.mediasource.dam.AssetRendition

Get file name of given rendition.

getFileName() - Method in interface io.wcm.handler.media.Rendition

Get file name of rendition.

getFileSize() - Method in interface io.wcm.handler.media.Rendition

Get file size of rendition.

getFileSizeMax() - Method in class io.wcm.handler.media.format.MediaFormat

Get maximum file size.

getFirstMediaFormat(Media) - Method in class io.wcm.handler.media.markup.SimpleImageMediaMarkupBuilder

Get first media format from the resolved media renditions.

getFirstMediaFormatWithRatio(Media) - Method in class io.wcm.handler.media.markup.SimpleImageMediaMarkupBuilder

Get first media format from the media formats of the media args that has a ratio set.

getFixedHeight() - Method in class io.wcm.handler.media.MediaArgs

Use fixed height instead of width from media format or original image

getFixedWidth() - Method in class io.wcm.handler.media.MediaArgs

Use fixed width instead of width from media format or original image

getHeight() - Method in class io.wcm.handler.media.Dimension

Get height in pixels.

getHeight() - Method in class io.wcm.handler.media.format.MediaFormat

Get image height.

getHeight() - Method in interface io.wcm.handler.media.Rendition

Gets the height of this rendition.

getId() - Method in class io.wcm.handler.media.spi.MediaSource

Get media source ID.

getId() - Method in class io.wcm.handler.mediasource.dam.DamMediaSource

getId() - Method in class io.wcm.handler.mediasource.inline.InlineMediaSource

getId() - Method in class io.wcm.handler.mediasource.ngdm.NextGenDynamicMediaMediaSource

getImageContentTypes() - Static method in enum class io.wcm.handler.media.MediaFileType

Get image content types supported by the Media Handler.

getImageElement(Media) - Method in class io.wcm.handler.media.markup.SimpleImageMediaMarkupBuilder

Create an img element that displays the given rendition image.

getImageFileExtensions() - Static method in enum class io.wcm.handler.media.MediaFileType

Get image file extensions supported by the Media Handler.

getImageQualityPercentage() - Method in class io.wcm.handler.media.MediaArgs

Get image quality percentage.

getImageRendition(MediaArgs) - Method in interface io.wcm.handler.media.Asset

Get the first image rendition that matches the given media args.

getImageSizes() - Method in class io.wcm.handler.media.MediaArgs

Get image sizes for responsive image handling.

getImageSizes() - Method in class io.wcm.handler.media.MediaComponentPropertyResolver

Get image sizes for responsive image handling.

getIncludeAssetAemRenditions() - Method in class io.wcm.handler.media.MediaArgs

Get which types of AEM-generated renditions are included.

getIncludeAssetAemRenditionsByDefault() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Set of renditions auto-generated by AEM (with cq5dam. prefix) which are taken into account by default when trying to resolve the media request.

getIPERatioCustomize() - Method in class io.wcm.handler.media.MediaArgs

Get IPE ratio customization setting.

getLabel() - Method in class io.wcm.handler.media.format.MediaFormat

Get media format label for display.

getLeft() - Method in class io.wcm.handler.media.CropDimension

Get left coordinate in pixels.

getLink() - Method in interface io.wcm.handler.media.imagemap.ImageMapArea

Returns link represent as link object

getLinkUrl() - Method in interface io.wcm.handler.media.imagemap.ImageMapArea

Returns the value for the href attribute of the image map area.

getLinkUrl(T) - Method in interface io.wcm.handler.media.spi.ImageMapLinkResolver

Get Link URL from link Object.

getLinkWindowTarget() - Method in interface io.wcm.handler.media.imagemap.ImageMapArea

Returns the value for the target attribute of the image map area.

getMandatoryMediaFormatNames() - Method in class io.wcm.handler.media.MediaComponentPropertyResolver

Get mandatory media format names.

getMap() - Method in class io.wcm.handler.media.Media

Get image map.

getMapProperty() - Method in class io.wcm.handler.media.MediaRequest.MediaPropertyNames

Get image map property name.

getMarkup() - Method in class io.wcm.handler.media.Media

Get media HTML element serialized to string.

getMarkup() - Method in class io.wcm.handler.media.ui.ResourceMedia

Returns the XHTML markup for the resolved media object (if valid).

getMarkupBuilders() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Get available media markup builders.

getMaxHeight() - Method in class io.wcm.handler.media.format.MediaFormat

Get maximum image height.

getMaxHeight() - Method in interface io.wcm.handler.media.UriTemplate

Get maximum height constraint.

getMaxWidth() - Method in class io.wcm.handler.media.format.MediaFormat

Get maximum image width.

getMaxWidth() - Method in interface io.wcm.handler.media.UriTemplate

Get maximum width constraint.

getMedia() - Method in class io.wcm.handler.media.MediaArgs.PictureSource

Get media query list.

getMediaAltTextProperty() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Get default alt text property name.

getMediaArgs() - Method in class io.wcm.handler.media.MediaRequest

Get media arguments.

getMediaCropDimension(MediaRequest, MediaHandlerConfig) - Method in class io.wcm.handler.media.spi.MediaSource

Get (optional) crop dimensions from resource

getMediaCropProperty() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Get default cropping property name.

getMediaCropProperty(MediaRequest, MediaHandlerConfig) - Method in class io.wcm.handler.media.spi.MediaSource

Get property name containing the cropping parameters

getMediaElement(Media) - Method in class io.wcm.handler.media.markup.SimpleImageMediaMarkupBuilder

Create img or picture media element.

getMediaForceAltTextFromAssetProperty() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Get default force alt from asset property name.

getMediaFormat() - Method in class io.wcm.handler.media.MediaArgs.MediaFormatOption

Get media format.

getMediaFormat() - Method in class io.wcm.handler.media.MediaArgs.PictureSource

Get media format.

getMediaFormat() - Method in interface io.wcm.handler.media.Rendition

Get media format of rendition.

getMediaFormat(String) - Method in interface io.wcm.handler.media.format.MediaFormatHandler

Resolves media format name to media format object.

getMediaformatDimension(Media) - Static method in class io.wcm.handler.media.markup.MediaMarkupBuilderUtil

Get dimension from first media format defined in media args.

getMediaFormatName() - Method in class io.wcm.handler.media.MediaArgs.MediaFormatOption

Get media format name.

getMediaFormatName() - Method in class io.wcm.handler.media.MediaArgs.PictureSource

Get media format name.

getMediaFormatNames() - Method in class io.wcm.handler.media.MediaArgs

Returns list of media formats to resolve to.

getMediaFormatNames() - Method in class io.wcm.handler.media.MediaComponentPropertyResolver

Get media format names.

getMediaFormatOptions() - Method in class io.wcm.handler.media.MediaArgs

Gets list of media formats to resolve to.

getMediaFormatOptions() - Method in class io.wcm.handler.media.MediaComponentPropertyResolver

Get media format options with mandatory flags.

getMediaFormats() - Method in interface io.wcm.handler.media.format.MediaFormatHandler

Get media formats defined by a CMS application that is responsible for the given media library path.

getMediaFormats() - Method in class io.wcm.handler.media.MediaArgs

Returns list of media formats to resolve to.

getMediaFormats() - Method in class io.wcm.handler.media.spi.MediaFormatProvider

Get media formats defined by this provider.

getMediaFormats(Comparator<MediaFormat>) - Method in interface io.wcm.handler.media.format.MediaFormatHandler

Get media formats defined by a CMS application that is responsible for the given media library path.

getMediaFormats(Resource) - Method in interface io.wcm.handler.media.format.MediaFormatProviderManager

Get all media format definitions for application.

getMediaInlineNodeName() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Get default inline media node name.

getMediaInvalidReason() - Method in class io.wcm.handler.media.Media

Get reason why the requested media could not be resolved.

getMediaInvalidReason() - Method in class io.wcm.handler.media.ui.MediaPlaceholder

Additional text to append to empty placeholder message.

getMediaInvalidReasonCustomMessage() - Method in class io.wcm.handler.media.Media

Get custom message when media invalid reason is CUSTOM.

getMediaIsDecorativeProperty() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Get default decorative image property name.

getMediaMap(MediaRequest, MediaHandlerConfig) - Method in class io.wcm.handler.media.spi.MediaSource

Get (optional) image map areas from resource

getMediaMapProperty() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Get default image map property name.

getMediaMapProperty(MediaRequest, MediaHandlerConfig) - Method in class io.wcm.handler.media.spi.MediaSource

Get property name containing the image map parameter

getMediaPropertyNames() - Method in class io.wcm.handler.media.MediaRequest

Get custom property names for media parameters.

getMediaRef() - Method in class io.wcm.handler.media.MediaRequest

Get media reference.

getMediaRef(MediaRequest, MediaHandlerConfig) - Method in class io.wcm.handler.media.spi.MediaSource

Get media request path to media library

getMediaRefProperty() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Get default media reference property name.

getMediaRefProperty(MediaRequest, MediaHandlerConfig) - Method in class io.wcm.handler.media.spi.MediaSource

Get property name containing the media request path

getMediaRequest() - Method in class io.wcm.handler.media.Media

Get media handling request.

getMediaRotation(MediaRequest, MediaHandlerConfig) - Method in class io.wcm.handler.media.spi.MediaSource

Get (optional) rotation from resource

getMediaRotationProperty() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Get default rotation property name.

getMediaRotationProperty(MediaRequest, MediaHandlerConfig) - Method in class io.wcm.handler.media.spi.MediaSource

Get property name containing the rotation parameter

getMediaSource() - Method in class io.wcm.handler.media.Media

Get media source.

getMetadata() - Method in class io.wcm.handler.media.ui.ResourceMedia

Returns a Media object with the metadata of the resolved media.

getMimeType() - Method in interface io.wcm.handler.media.Rendition

Get MIME type of rendition.

getMinDimension() - Method in class io.wcm.handler.media.format.MediaFormat

Get minimum dimensions for media format.

getMinHeight() - Method in class io.wcm.handler.media.format.MediaFormat

Get minimum image height.

getMinWidth() - Method in class io.wcm.handler.media.format.MediaFormat

Get minimum image width.

getMinWidthHeight() - Method in class io.wcm.handler.media.format.MediaFormat

Get minimum width/height constraint.

getModificationDate() - Method in interface io.wcm.handler.media.Rendition

getName() - Method in class io.wcm.handler.media.format.MediaFormat

Get media format name.

getPath() - Method in interface io.wcm.handler.media.Asset

Internal path pointing to media item, if it is stored in the JCR repository.

getPath() - Method in interface io.wcm.handler.media.Rendition

Returns the internal path of the rendition if stored within the JCR repository.

getPictureElement(Media) - Method in class io.wcm.handler.media.markup.SimpleImageMediaMarkupBuilder

Create an img element that displays the given rendition image.

getPictureSources() - Method in class io.wcm.handler.media.MediaArgs

Get picture sources for responsive image handling.

getPictureSources() - Method in class io.wcm.handler.media.MediaComponentPropertyResolver

Get picture sources for responsive image handling.

getPostProcessors() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Get media metadata post processors.

getPreProcessors() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Get media metadata pre processors.

getPrimaryMediaRefProperty() - Method in class io.wcm.handler.media.spi.MediaSource

Get name of the property in which the primary media request is stored.

getPrimaryMediaRefProperty() - Method in class io.wcm.handler.mediasource.dam.DamMediaSource

getPrimaryMediaRefProperty() - Method in class io.wcm.handler.mediasource.inline.InlineMediaSource

getPrimaryMediaRefProperty() - Method in class io.wcm.handler.mediasource.ngdm.NextGenDynamicMediaMediaSource

getProperties() - Method in interface io.wcm.handler.media.Asset

Get properties of media item.

getProperties() - Method in class io.wcm.handler.media.format.MediaFormat

Get custom properties.

getProperties() - Method in class io.wcm.handler.media.MediaArgs

Custom properties that my be used by application-specific markup builders or processors.

getProperties() - Method in interface io.wcm.handler.media.Rendition

Get properties of rendition.

getRanking() - Method in class io.wcm.handler.media.format.MediaFormat

Get ranking for auto-detection priority.

getRatio() - Method in class io.wcm.handler.media.format.MediaFormat

Returns the ratio defined in the media format definition.

getRatio() - Method in interface io.wcm.handler.media.Rendition

Gets the ratio of the image (width / height).

getRatioDisplayString() - Method in class io.wcm.handler.media.format.MediaFormat

Return display string for defined ratio.

getRatioHeightAsDouble() - Method in class io.wcm.handler.media.format.MediaFormat

Get ratio height value.

getRatioWidthAsDouble() - Method in class io.wcm.handler.media.format.MediaFormat

Get ratio width value.

getRectangle() - Method in class io.wcm.handler.media.CropDimension

Get rectangle representation of crop dimension.

getRefProperty() - Method in class io.wcm.handler.media.MediaRequest.MediaPropertyNames

Get media reference property name.

getRelativeCoordinates() - Method in interface io.wcm.handler.media.imagemap.ImageMapArea

Returns the value for a relative unit representation of the coords attribute of the image map area.

getRendition() - Method in class io.wcm.handler.media.Media

Get first (and best-match) rendition that was resolved during media handler processing

getRendition(MediaArgs) - Method in interface io.wcm.handler.media.Asset

Get the first rendition that matches the given media args.

getRenditionGroup() - Method in class io.wcm.handler.media.format.MediaFormat

Get rendition group ID.

getRenditions() - Method in class io.wcm.handler.media.Media

Get all renditions that were resolved during media handler processing

getRequest() - Method in class io.wcm.handler.media.markup.AbstractImageMediaMarkupBuilder

Get current Sling HTTP servlet request.

getResource() - Method in class io.wcm.handler.media.MediaRequest

Get resource containing media reference.

getResourceProperties() - Method in class io.wcm.handler.media.MediaRequest

Get properties from resource.

getRight() - Method in class io.wcm.handler.media.CropDimension

Get right coordinate in pixels.

getRotation() - Method in class io.wcm.handler.media.Media

Get image rotation.

getRotationProperty() - Method in class io.wcm.handler.media.MediaRequest.MediaPropertyNames

Get rotation property name.

getSameBiggerMediaFormats(MediaFormat, boolean) - Method in interface io.wcm.handler.media.format.MediaFormatHandler

Get list of media formats that have the same (or bigger) resolution as the requested media format and (nearly) the same aspect ratio.

getSameSmallerMediaFormats(MediaFormat, boolean) - Method in interface io.wcm.handler.media.format.MediaFormatHandler

Get list of possible media formats that can be rendered from the given media format, i.e. same size or smaller and (nearly) the same aspect ratio.

getShape() - Method in interface io.wcm.handler.media.imagemap.ImageMapArea

Returns the value for the shape attribute of the image map area.

getSizes() - Method in class io.wcm.handler.media.MediaArgs.ImageSizes

Get source size list.

getSizes() - Method in class io.wcm.handler.media.MediaArgs.PictureSource

Get source size list.

getSources() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Get supported media sources.

getSrcSetRenditions(Media, MediaFormat, long...) - Method in class io.wcm.handler.media.markup.SimpleImageMediaMarkupBuilder

Generate srcset list from the resolved renditions for the ratio of the given media formats and the given widths.

getSrcSetRenditions(Media, MediaFormat, MediaArgs.WidthOption...) - Method in class io.wcm.handler.media.markup.SimpleImageMediaMarkupBuilder

Generate srcset list from the resolved renditions for the ratio of the given media formats and the given widths.

getSrcSetRenditions(Media, MediaFormat, MediaArgs.WidthOption[], boolean) - Method in class io.wcm.handler.media.markup.SimpleImageMediaMarkupBuilder

Generate srcset list from the resolved renditions for the ratio of the given media formats and the given widths.

getSrcSetRenditionUrl(Media, MediaFormat, MediaArgs.WidthOption, boolean) - Method in class io.wcm.handler.media.markup.SimpleImageMediaMarkupBuilder

Generate a rendition URL with descriptor (width or density) for the given media format and width option

getTitle() - Method in interface io.wcm.handler.media.Asset

Get title of media item.

getTop() - Method in class io.wcm.handler.media.CropDimension

Get top coordinate in pixels.

getType() - Method in interface io.wcm.handler.media.UriTemplate

Get URI template type.

getUriTemplate() - Method in interface io.wcm.handler.media.UriTemplate

Get URI template string.

getUriTemplate(UriTemplateType) - Method in interface io.wcm.handler.media.Asset

Generate an URI template for the asset.

getUriTemplate(UriTemplateType) - Method in interface io.wcm.handler.media.Rendition

Generate an URI template for the rendition.

getUrl() - Method in class io.wcm.handler.media.Media

Get media URL.

getUrl() - Method in interface io.wcm.handler.media.Rendition

Get externalized URL pointing to the rendition.

getUrlMode() - Method in class io.wcm.handler.media.MediaArgs

Get URL mode.

getVectorImageContentTypes() - Static method in enum class io.wcm.handler.media.MediaFileType

Get vector image content types.

getVectorImageFileExtensions() - Static method in enum class io.wcm.handler.media.MediaFileType

Get vector image file extensions.

getVideoPlayerElement(Media) - Method in class io.wcm.handler.mediasource.dam.markup.DamVideoMediaMarkupBuilder

Build HTML5 video player element

getVideoProfileNames() - Method in class io.wcm.handler.mediasource.dam.markup.DamVideoMediaMarkupBuilder

Return video profile names stored below /etc/dam/video supported by this markup builder.

getVideoProfiles() - Method in class io.wcm.handler.mediasource.dam.markup.DamVideoMediaMarkupBuilder

Return video profiles supported by this markup builder.

getWcmMode() - Method in class io.wcm.handler.media.markup.AbstractImageMediaMarkupBuilder

Get current WCM mode.

getWidth() - Method in class io.wcm.handler.media.Dimension

Get width in pixels.

getWidth() - Method in class io.wcm.handler.media.format.MediaFormat

Get image width.

getWidth() - Method in class io.wcm.handler.media.MediaArgs.WidthOption

Get width value.

getWidth() - Method in interface io.wcm.handler.media.Rendition

Gets the width of this rendition.

getWidthDescriptor() - Method in class io.wcm.handler.media.MediaArgs.WidthOption

Get width descriptor for srcset attribute.

getWidthOptions() - Method in class io.wcm.handler.media.MediaArgs.ImageSizes

Get width options for responsive image renditions.

getWidthOptions() - Method in class io.wcm.handler.media.MediaArgs.PictureSource

Get width options for renditions.

GIF - Enum constant in enum class io.wcm.handler.media.MediaFileType

GIF

H

hasDensityDescriptors() - Method in class io.wcm.handler.media.MediaArgs.ImageSizes

Check if density descriptors should be used.

hasDensityDescriptors() - Method in class io.wcm.handler.media.MediaArgs.PictureSource

Check if density descriptors should be used.

hashCode() - Method in class io.wcm.handler.media.CropDimension

hashCode() - Method in class io.wcm.handler.media.Dimension

hashCode() - Method in class io.wcm.handler.media.format.MediaFormat

hashCode() - Method in class io.wcm.handler.media.MediaArgs

hashCode() - Method in class io.wcm.handler.media.MediaArgs.ImageSizes

hashCode() - Method in class io.wcm.handler.media.MediaArgs.MediaFormatOption

hashCode() - Method in class io.wcm.handler.media.MediaArgs.PictureSource

hashCode() - Method in class io.wcm.handler.media.MediaArgs.WidthOption

hasRatio() - Method in class io.wcm.handler.media.format.MediaFormat

Check if media format has ratio.

height(long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set fixed image height.

height(long, long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set image height range.

I

ID - Static variable in class io.wcm.handler.mediasource.dam.DamMediaSource

Media source ID

ID - Static variable in class io.wcm.handler.mediasource.inline.InlineMediaSource

Media source ID

ID - Static variable in class io.wcm.handler.mediasource.ngdm.NextGenDynamicMediaMediaSource

Media source ID

ImageMapArea - Interface in io.wcm.handler.media.imagemap

Represents an image map area defined by the AEM image editor.

ImageMapLinkResolver<T> - Interface in io.wcm.handler.media.spi

Resolves link URLs found in Image Map definitions.

ImageMapParser - Interface in io.wcm.handler.media.imagemap

Parses image maps produced by the AEM image editor.

imageQualityPercentage(Double) - Method in interface io.wcm.handler.media.MediaBuilder

Set image quality percentage.

imageQualityPercentage(Double) - Method in class io.wcm.handler.media.MediaArgs

Set image quality percentage.

imageSizes(MediaArgs.ImageSizes) - Method in class io.wcm.handler.media.MediaArgs

Set image sizes for responsive image handling.

imageSizes(String, long...) - Method in interface io.wcm.handler.media.MediaBuilder

Apply responsive image handling for the img element based on the primary media format given.

imageSizes(String, MediaArgs.WidthOption...) - Method in interface io.wcm.handler.media.MediaBuilder

Apply responsive image handling for the img element based on the primary media format given.

ImageSizes(String, long...) - Constructor for class io.wcm.handler.media.MediaArgs.ImageSizes

Create image sizes with widths.

ImageSizes(String, MediaArgs.WidthOption...) - Constructor for class io.wcm.handler.media.MediaArgs.ImageSizes

Create image sizes with width options.

includeAssetAemRenditions(Set<AemRenditionType>) - Method in interface io.wcm.handler.media.MediaBuilder

Set which types of AEM-generated renditions are included.

includeAssetAemRenditions(Set<AemRenditionType>) - Method in class io.wcm.handler.media.MediaArgs

Set which types of AEM-generated renditions are included.

includeAssetThumbnails(boolean) - Method in class io.wcm.handler.media.MediaArgs

Deprecated.

Use MediaArgs.includeAssetAemRenditions(Set) instead.

includeAssetThumbnails(boolean) - Method in interface io.wcm.handler.media.MediaBuilder

Deprecated.

Please use MediaBuilder.includeAssetAemRenditions(Set) instead.

includeAssetWebRenditions(boolean) - Method in class io.wcm.handler.media.MediaArgs

Deprecated.

Use MediaArgs.includeAssetAemRenditions(Set) instead.

includeAssetWebRenditions(boolean) - Method in interface io.wcm.handler.media.MediaBuilder

Deprecated.

Please use MediaBuilder.includeAssetAemRenditions(Set) instead.

includeAssetWebRenditionsByDefault() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

Deprecated.

Use MediaHandlerConfig.getIncludeAssetAemRenditionsByDefault() instead.

InlineMediaSource - Class in io.wcm.handler.mediasource.inline

Default implementation for media references to binaries stored in a node inside the content page.

InlineMediaSource() - Constructor for class io.wcm.handler.mediasource.inline.InlineMediaSource

internal(boolean) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set whether format is for internal use only.

invalid() - Method in interface io.wcm.handler.media.MediaHandler

Returns an empty media that is marked as invalid.

INVALID_MEDIA_FORMAT - Enum constant in enum class io.wcm.handler.media.MediaInvalidReason

One or all of the given media format names are invalid.

io.wcm.handler.media - package io.wcm.handler.media

Media Handler API.

io.wcm.handler.media.format - package io.wcm.handler.media.format

Media format management.

io.wcm.handler.media.imagemap - package io.wcm.handler.media.imagemap

Image Map parsing.

io.wcm.handler.media.markup - package io.wcm.handler.media.markup

Default media markup builder implementations.

io.wcm.handler.media.spi - package io.wcm.handler.media.spi

SPI for configuring and tailoring media handler processing.

io.wcm.handler.media.ui - package io.wcm.handler.media.ui

Sling model classes for UI views.

io.wcm.handler.mediasource.dam - package io.wcm.handler.mediasource.dam

Media source implementation for assets stored in DAM.

io.wcm.handler.mediasource.dam.markup - package io.wcm.handler.mediasource.dam.markup

Default media markup implementations for DAM.

io.wcm.handler.mediasource.inline - package io.wcm.handler.mediasource.inline

Media source implementation for binaries stored inline in the page content.

io.wcm.handler.mediasource.ngdm - package io.wcm.handler.mediasource.ngdm

Media source implementation for Dynamic Media with OpenAPI.

ipeRatioCustomize(IPERatioCustomize) - Method in class io.wcm.handler.media.MediaArgs

Set IPE ratio customization setting.

IPERatioCustomize - Enum Class in io.wcm.handler.media.markup

Controls whether the list of IPE cropping ratios is customized by the media handler to match with the ratios of the selected media formats.

isAutoCrop() - Method in class io.wcm.handler.media.CropDimension

Check if dimension is marked as auto-cropped.

isAutoCrop() - Method in class io.wcm.handler.media.MediaArgs

Check if auto-cropping mode is enabled.

isAutoCrop() - Method in class io.wcm.handler.media.MediaComponentPropertyResolver

Check if auto-crop is enabled.

isBrowserImage() - Method in interface io.wcm.handler.media.Rendition

Check if rendition is a browser-displayable image.

isBrowserImage(String) - Static method in enum class io.wcm.handler.media.MediaFileType

Check if the given file extension is supported for direct display in a browser.

isContentDispositionAttachment() - Method in class io.wcm.handler.media.MediaArgs

Check if Content-Disposition header should be set to attachment.

isDecorative() - Method in class io.wcm.handler.media.MediaArgs

Check if image is marked as decorative.

isDownload() - Method in class io.wcm.handler.media.format.MediaFormat

Check if media should be downloaded.

isDownload() - Method in class io.wcm.handler.media.MediaArgs

Check if only download media formats are accepted.

isDownload() - Method in interface io.wcm.handler.media.Rendition

Check if rendition should be downloaded.

isDummyImage() - Method in class io.wcm.handler.media.MediaArgs

Check if dummy image is enabled.

isDynamicMediaDisabled() - Method in class io.wcm.handler.media.MediaArgs

Check if dynamic media support is disabled.

isEnabled() - Method in class io.wcm.handler.mediasource.ngdm.NextGenDynamicMediaConfigModel

Check if Next Gen Dynamic Media is enabled.

isFallback() - Method in interface io.wcm.handler.media.Rendition

Check if this is a fallback rendition.

isFixedDimension() - Method in class io.wcm.handler.media.format.MediaFormat

Checks if the media format has a fixed width and height defined, and no min/max constraints.

isFixedHeight() - Method in class io.wcm.handler.media.format.MediaFormat

Checks if the media format has a fixed height defined, and no min/max constraints.

isFixedWidth() - Method in class io.wcm.handler.media.format.MediaFormat

Checks if the media format has a fixed width defined, and no min/max constraints.

isForceAltValueFromAsset() - Method in class io.wcm.handler.media.MediaArgs

Check if alt text should be forced from DAM asset description.

isImage() - Method in class io.wcm.handler.media.format.MediaFormat

Check if format allows image extensions.

isImage() - Method in interface io.wcm.handler.media.Rendition

Check if rendition is an image.

isImage(String) - Static method in enum class io.wcm.handler.media.MediaFileType

Check if the given file extension is supported by the Media Handler for rendering as image.

isImageQualityPercentage() - Method in enum class io.wcm.handler.media.MediaFileType

Check if this image type supports quality percentage.

isIncludeAssetThumbnails() - Method in class io.wcm.handler.media.MediaArgs

Deprecated.

Use MediaArgs.includeAssetAemRenditions(Set) instead.

isIncludeAssetWebRenditions() - Method in class io.wcm.handler.media.MediaArgs

Deprecated.

Use MediaArgs.includeAssetAemRenditions(Set) instead.

isInternal() - Method in class io.wcm.handler.media.format.MediaFormat

Check if format is for internal use only.

isMandatory() - Method in class io.wcm.handler.media.MediaArgs.MediaFormatOption

Check if resolution of this media format is mandatory.

isMandatory() - Method in class io.wcm.handler.media.MediaArgs.WidthOption

Check if width is mandatory.

isOriginal(Rendition) - Static method in class io.wcm.handler.mediasource.dam.AssetRendition

Checks if the given rendition is the original file of the asset

isThumbnailRendition(Rendition) - Static method in class io.wcm.handler.mediasource.dam.AssetRendition

Checks if the given rendition is a thumbnail rendition generated automatically by AEM (with cq5dam.thumbnail. prefix).

isValid() - Method in class io.wcm.handler.media.Media

Check if media is valid.

isValid() - Method in class io.wcm.handler.media.ui.ResourceMedia

Returns true if the media was resolved successful.

isValidElement(HtmlElement) - Method in interface io.wcm.handler.media.MediaHandler

Checks if the given HTML element is valid.

isValidMedia(HtmlElement) - Method in class io.wcm.handler.media.markup.DummyImageMediaMarkupBuilder

isValidMedia(HtmlElement) - Method in class io.wcm.handler.media.markup.SimpleImageMediaMarkupBuilder

isValidMedia(HtmlElement) - Method in interface io.wcm.handler.media.spi.MediaMarkupBuilder

Checks if the given HTML element is valid.

isValidMedia(HtmlElement) - Method in class io.wcm.handler.mediasource.dam.markup.DamVideoMediaMarkupBuilder

isVectorImage() - Method in interface io.wcm.handler.media.Rendition

Check if rendition is a vector image.

isVectorImage(String) - Static method in enum class io.wcm.handler.media.MediaFileType

Check if the given file extension is a vector image file extension.

isWebOptimizedImageDeliveryDisabled() - Method in class io.wcm.handler.media.MediaArgs

Check if web-optimized image delivery is disabled.

isWebRendition(Rendition) - Static method in class io.wcm.handler.mediasource.dam.AssetRendition

Checks if the given rendition is a web rendition generated automatically by AEM for the image editor/cropping (with cq5dam.web. prefix).

J

JPEG - Enum constant in enum class io.wcm.handler.media.MediaFileType

JPEG

L

label(String) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set label for displaying to user.

M

mandatoryMediaFormatNames(String...) - Method in interface io.wcm.handler.media.MediaBuilder

Sets list of media formats to resolve to.

mandatoryMediaFormatNames(String...) - Method in class io.wcm.handler.media.MediaArgs

Sets list of media formats to resolve to.

mandatoryMediaFormats(MediaFormat...) - Method in interface io.wcm.handler.media.MediaBuilder

Sets list of media formats to resolve to.

mandatoryMediaFormats(MediaFormat...) - Method in class io.wcm.handler.media.MediaArgs

Sets list of media formats to resolve to.

mapProperty(String) - Method in interface io.wcm.handler.media.MediaBuilder

Set the name of the property which contains the image map data.

mapProperty(String) - Method in class io.wcm.handler.media.MediaRequest.MediaPropertyNames

Set image map property name.

matches(double, double) - Static method in class io.wcm.handler.media.format.Ratio

Checks if both given ratio values are the same within the bounds of the MediaFormatHandler.RATIO_TOLERANCE.

matches(Rendition) - Method in enum class io.wcm.handler.mediasource.dam.AemRenditionType

Check if rendition matches this type.

matches(MediaFormat, MediaFormat) - Static method in class io.wcm.handler.media.format.Ratio

Checks if the ratios of both given media formats are the same within the bounds of the MediaFormatHandler.RATIO_TOLERANCE.

matches(String) - Method in enum class io.wcm.handler.mediasource.dam.AemRenditionType

Check if rendition name matches this type.

maxHeight(long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set maximum image height.

maxWidth(long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set maximum image width.

media(String) - Method in class io.wcm.handler.media.MediaArgs.PictureSource

Set media query list.

Media - Class in io.wcm.handler.media

Holds information about a media request processed and resolved by MediaHandler.

Media(MediaSource, MediaRequest) - Constructor for class io.wcm.handler.media.Media

Create a media object.

MEDIA_REFERENCE_INVALID - Enum constant in enum class io.wcm.handler.media.MediaInvalidReason

Media item not found: that means the media request path is invalid or the user has no read access.

MEDIA_REFERENCE_MISSING - Enum constant in enum class io.wcm.handler.media.MediaInvalidReason

The media request was empty.

MediaArgs - Class in io.wcm.handler.media

Holds parameters to influence the media resolving process.

MediaArgs() - Constructor for class io.wcm.handler.media.MediaArgs

Default constructor

MediaArgs(MediaFormat...) - Constructor for class io.wcm.handler.media.MediaArgs

Create media arguments with media formats.

MediaArgs(String...) - Constructor for class io.wcm.handler.media.MediaArgs

Create media arguments with media format names.

MediaArgs.ImageSizes - Class in io.wcm.handler.media

Image sizes for responsive image handling.

MediaArgs.MediaFormatOption - Class in io.wcm.handler.media

Media format to be applied on media processing.

MediaArgs.PictureSource - Class in io.wcm.handler.media

Picture source for responsive image handling.

MediaArgs.WidthOption - Class in io.wcm.handler.media

Width value with mandatory flag.

MediaBuilder - Interface in io.wcm.handler.media

Define media handling request using builder pattern.

MediaComponentPropertyResolver - Class in io.wcm.handler.media

Resolves Media Handler component properties for the component associated with the given resource from content policies and properties defined in the component resource.

MediaComponentPropertyResolver(Resource, ComponentPropertyResolverFactory) - Constructor for class io.wcm.handler.media.MediaComponentPropertyResolver

Resolves

MediaComponentPropertyResolver(ValueMap) - Constructor for class io.wcm.handler.media.MediaComponentPropertyResolver

Create resolver with value map.

MediaFileType - Enum Class in io.wcm.handler.media

File types supported by Media Handler.

mediaFormat(MediaFormat) - Method in interface io.wcm.handler.media.MediaBuilder

Sets a single media format to resolve to.

mediaFormat(MediaFormat) - Method in class io.wcm.handler.media.MediaArgs

Sets a single media format to resolve to.

MediaFormat - Class in io.wcm.handler.media.format

Media format.

MEDIAFORMAT_PROP_PARENT_MEDIA_FORMAT - Static variable in class io.wcm.handler.media.MediaNameConstants

Media format property name for the parent media format.

MediaFormatBuilder - Class in io.wcm.handler.media.format

Fluent API for building media format definitions.

MediaFormatCombinedTitleComparator - Class in io.wcm.handler.media.format

Sorts media formats by combined title.

MediaFormatCombinedTitleComparator() - Constructor for class io.wcm.handler.media.format.MediaFormatCombinedTitleComparator

MediaFormatHandler - Interface in io.wcm.handler.media.format

Media format handling.

mediaFormatName(String) - Method in interface io.wcm.handler.media.MediaBuilder

Sets a single media format to resolve to.

mediaFormatName(String) - Method in class io.wcm.handler.media.MediaArgs

Sets a single media format to resolve to.

mediaFormatNames(String...) - Method in interface io.wcm.handler.media.MediaBuilder

Sets list of media formats to resolve to.

mediaFormatNames(String...) - Method in class io.wcm.handler.media.MediaArgs

Sets list of media formats to resolve to.

MediaFormatOption(MediaFormat, boolean) - Constructor for class io.wcm.handler.media.MediaArgs.MediaFormatOption

Create media format option.

MediaFormatOption(String, boolean) - Constructor for class io.wcm.handler.media.MediaArgs.MediaFormatOption

Create media format option with format name.

mediaFormatOptions(MediaArgs.MediaFormatOption...) - Method in interface io.wcm.handler.media.MediaBuilder

Sets list of media formats to resolve to.

mediaFormatOptions(MediaArgs.MediaFormatOption...) - Method in class io.wcm.handler.media.MediaArgs

Sets list of media formats to resolve to.

MediaFormatProvider - Class in io.wcm.handler.media.spi

MediaFormatProvider OSGi services provide media formats for the media handler.

MediaFormatProvider(Class<?>) - Constructor for class io.wcm.handler.media.spi.MediaFormatProvider

Initialize provider from media format definitions in class fields.

MediaFormatProvider(Set<MediaFormat>) - Constructor for class io.wcm.handler.media.spi.MediaFormatProvider

Initialize provider with explicit set of media formats.

MediaFormatProviderManager - Interface in io.wcm.handler.media.format

Collects all media format definitions provided by applications via MediaFormatProvider interface.

MediaFormatRankingComparator - Class in io.wcm.handler.media.format

Sorts media formats by ranking and name.

MediaFormatRankingComparator() - Constructor for class io.wcm.handler.media.format.MediaFormatRankingComparator

mediaFormats(MediaFormat...) - Method in interface io.wcm.handler.media.MediaBuilder

Sets list of media formats to resolve to.

mediaFormats(MediaFormat...) - Method in class io.wcm.handler.media.MediaArgs

Sets list of media formats to resolve to.

MediaFormatSizeRankingComparator - Class in io.wcm.handler.media.format

Sorts media formats by size (biggest first), ranking and name.

MediaFormatSizeRankingComparator() - Constructor for class io.wcm.handler.media.format.MediaFormatSizeRankingComparator

mediaFormatsMandatory(boolean) - Method in class io.wcm.handler.media.MediaArgs

The "mandatory" flag of all media format options is set to to the given value.

mediaFormatsMandatory(boolean) - Method in interface io.wcm.handler.media.MediaBuilder

If set to true, media handler never returns a dummy image.

MediaHandler - Interface in io.wcm.handler.media

Manages media resolving and markup generation.

MediaHandlerConfig - Class in io.wcm.handler.media.spi

MediaHandlerConfig OSGi services provide application-specific configuration for media handling.

MediaHandlerConfig() - Constructor for class io.wcm.handler.media.spi.MediaHandlerConfig

MediaInvalidReason - Enum Class in io.wcm.handler.media

Reasons while a media request could not be resolved.

MediaMarkupBuilder - Interface in io.wcm.handler.media.spi

Builds XHTML markup for media element.

MediaMarkupBuilderUtil - Class in io.wcm.handler.media.markup

Helper methods for MediaMarkupBuilder implementations.

MediaNameConstants - Class in io.wcm.handler.media

Names used for media handling.

MediaPlaceholder - Class in io.wcm.handler.media.ui

Model for media replacement placeholder.

MediaPlaceholder() - Constructor for class io.wcm.handler.media.ui.MediaPlaceholder

MediaProcessor - Interface in io.wcm.handler.media.spi

Processes media metadata before or after media resolving.

MediaPropertyNames() - Constructor for class io.wcm.handler.media.MediaRequest.MediaPropertyNames

MediaRequest - Class in io.wcm.handler.media

Holds all properties that are part of a media handling request.

MediaRequest(String, MediaArgs) - Constructor for class io.wcm.handler.media.MediaRequest

Create media request from media reference.

MediaRequest(Resource, MediaArgs) - Constructor for class io.wcm.handler.media.MediaRequest

Create media request from resource.

MediaRequest(Resource, String, MediaArgs, MediaRequest.MediaPropertyNames) - Constructor for class io.wcm.handler.media.MediaRequest

Create media request with all parameters.

MediaRequest.MediaPropertyNames - Class in io.wcm.handler.media

Defines property names to read media parameters from for this media request.

MediaSource - Class in io.wcm.handler.media.spi

Via MediaSource OSGi services applications can define additional media sources supported by MediaHandler.

MediaSource() - Constructor for class io.wcm.handler.media.spi.MediaSource

minHeight(long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set minimum image height.

minWidth(long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set minimum image width.

minWidthHeight(long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set minimum width/height dimension.

N

NEVER - Enum constant in enum class io.wcm.handler.media.markup.DragDropSupport

Never apply drag&drop support.

NEVER - Enum constant in enum class io.wcm.handler.media.markup.IPERatioCustomize

Never set customized cropping ratios.

NextGenDynamicMediaConfigModel - Class in io.wcm.handler.mediasource.ngdm

Prepares Dynamic Media with OpenAPI Remote Assets configuration for GraniteUI components (fileupload, pathfield).

NextGenDynamicMediaConfigModel() - Constructor for class io.wcm.handler.mediasource.ngdm.NextGenDynamicMediaConfigModel

NextGenDynamicMediaMediaSource - Class in io.wcm.handler.mediasource.ngdm

Handles remote asset referenced via Dynamic Media with OpenAPI.

NextGenDynamicMediaMediaSource() - Constructor for class io.wcm.handler.mediasource.ngdm.NextGenDynamicMediaMediaSource

NN_COMPONENT_MEDIA_RESPONSIVEIMAGE_SIZES - Static variable in class io.wcm.handler.media.MediaNameConstants

Defines "image sizes" responsive image setting.

NN_COMPONENT_MEDIA_RESPONSIVEPICTURE_SOURCES - Static variable in class io.wcm.handler.media.MediaNameConstants

Defines "picture sources" responsive image setting.

NN_MEDIA_INLINE - Static variable in class io.wcm.handler.media.MediaNameConstants

Default node name for inline media item stored in node within the content page (Legacy wcm.io Handler Standard)

NN_MEDIA_INLINE_STANDARD - Static variable in class io.wcm.handler.media.MediaNameConstants

Default node name for inline media item stored in node within the content page (Adobe/Core Component standard)

NO_MATCHING_RENDITION - Enum constant in enum class io.wcm.handler.media.MediaInvalidReason

No matching rendition: The media item exists, but no rendition matches for the requested media args.

NOT_APPROVED - Enum constant in enum class io.wcm.handler.media.MediaInvalidReason

Media reference is valid, but the media is not approved.

NOT_ENOUGH_MATCHING_RENDITIONS - Enum constant in enum class io.wcm.handler.media.MediaInvalidReason

Not enough matching renditions: The media item exists and some renditions could be resolved, but not for all mandatory media formats requested.

NT_MEDIAFORMAT - Static variable in class io.wcm.handler.media.MediaNameConstants

Media format node type

O

OTHER_RENDITION - Enum constant in enum class io.wcm.handler.mediasource.dam.AemRenditionType

Any other rendition generated by AEM (with cq5dam. or cqdam. prefix).

P

parseMap(String) - Method in interface io.wcm.handler.media.imagemap.ImageMapParser

Parses a map area string to ImageMapArea objects.

pictureSource(MediaArgs.PictureSource) - Method in interface io.wcm.handler.media.MediaBuilder

Apply responsive image handling using picture and source elements.

PictureSource(MediaFormat) - Constructor for class io.wcm.handler.media.MediaArgs.PictureSource

Create picture source with media format.

PictureSource(String) - Constructor for class io.wcm.handler.media.MediaArgs.PictureSource

Create picture source with media format name.

pictureSources(MediaArgs.PictureSource...) - Method in class io.wcm.handler.media.MediaArgs

Set picture sources for responsive image handling.

PN_COMPONENT_MEDIA_AUTOCROP - Static variable in class io.wcm.handler.media.MediaNameConstants

Enable "auto-cropping" mode for this component by setting to true.

PN_COMPONENT_MEDIA_FORMATS - Static variable in class io.wcm.handler.media.MediaNameConstants

List of media format names accepted by this component.

PN_COMPONENT_MEDIA_FORMATS_MANDATORY - Static variable in class io.wcm.handler.media.MediaNameConstants

Resolving of all media formats is mandatory.

PN_COMPONENT_MEDIA_FORMATS_MANDATORY_NAMES - Static variable in class io.wcm.handler.media.MediaNameConstants

List of media format names that are mandatory.

PN_COMPONENT_MEDIA_RESPONSIVE_TYPE - Static variable in class io.wcm.handler.media.MediaNameConstants

If multiple responsive image settings are defined, this property defines which gets active.

PN_MEDIA_ALTTEXT - Static variable in class io.wcm.handler.media.MediaNameConstants

Default property name for media alt. text (Legacy wcm.io Handler Standard)

PN_MEDIA_ALTTEXT_STANDARD - Static variable in class io.wcm.handler.media.MediaNameConstants

Default property name for media alt. text (Adobe/Core Component standard)

PN_MEDIA_CROP - Static variable in class io.wcm.handler.media.MediaNameConstants

Default property name for cropping parameters (Legacy wcm.io Handler Standard)

PN_MEDIA_CROP_STANDARD - Static variable in class io.wcm.handler.media.MediaNameConstants

Default property name for cropping parameters (Adobe/Core Component standard)

PN_MEDIA_FORCE_ALTTEXT_FROM_ASSET - Static variable in class io.wcm.handler.media.MediaNameConstants

Default property name for forcing reading alt. text from DAM asset description (Legacy wcm.io Handler Standard)

PN_MEDIA_FORCE_ALTTEXT_FROM_ASSET_STANDARD - Static variable in class io.wcm.handler.media.MediaNameConstants

Default property name for forcing reading alt. text from DAM asset description (Adobe/Core Component standard)

PN_MEDIA_IS_DECORATIVE - Static variable in class io.wcm.handler.media.MediaNameConstants

Default property name for marking image as "decorative" - requiring no alt. text (Legacy wcm.io Handler Standard)

PN_MEDIA_IS_DECORATIVE_STANDARD - Static variable in class io.wcm.handler.media.MediaNameConstants

Default property name for marking image as "decorative" - requiring no alt. text (Adobe/Core Component standard)

PN_MEDIA_MAP - Static variable in class io.wcm.handler.media.MediaNameConstants

Default property name for map parameter (Legacy wcm.io Handler Standard)

PN_MEDIA_MAP_STANDARD - Static variable in class io.wcm.handler.media.MediaNameConstants

Default property name for map parameter (Adobe/Core Component standard)

PN_MEDIA_REF - Static variable in class io.wcm.handler.media.MediaNameConstants

Default property name for reference to media library item (Legacy wcm.io Handler Standard)

PN_MEDIA_REF_STANDARD - Static variable in class io.wcm.handler.media.MediaNameConstants

Default property name for reference to media library item (Adobe/Core Component standard)

PN_MEDIA_ROTATION - Static variable in class io.wcm.handler.media.MediaNameConstants

Default property name for rotate parameter (Legacy wcm.io Handler Standard)

PN_MEDIA_ROTATION_STANDARD - Static variable in class io.wcm.handler.media.MediaNameConstants

Default property name for rotate parameter (Adobe/Core Component standard)

PN_MEDIA_SOURCE - Static variable in class io.wcm.handler.media.MediaNameConstants

Media source

PNG - Enum constant in enum class io.wcm.handler.media.MediaFileType

PNG

process(Media) - Method in interface io.wcm.handler.media.spi.MediaProcessor

Process media metadata

PROP_CSS_CLASS - Static variable in class io.wcm.handler.media.MediaNameConstants

Property name for setting additional CSS classes

properties(Map<String, Object>) - Method in class io.wcm.handler.media.MediaArgs

Custom properties that my be used by application-specific markup builders or processors.

properties(Map<String, Object>) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Custom properties that my be used by application-specific markup builders or processors.

property(String, Object) - Method in class io.wcm.handler.media.MediaArgs

Custom properties that my be used by application-specific markup builders or processors.

property(String, Object) - Method in interface io.wcm.handler.media.MediaBuilder

Adds a custom property that my be used by application-specific markup builders or processors.

property(String, Object) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Custom properties that my be used by application-specific markup builders or processors.

R

ranking(int) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set ranking for auto-detection priority.

ratio(double) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set ratio width/height as double value.

ratio(double, double) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set ratio width and height sample values as doubles.

ratio(long, long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set ratio width and height sample values.

Ratio - Class in io.wcm.handler.media.format

Compare ratios with tolerance.

RATIO_TOLERANCE - Static variable in interface io.wcm.handler.media.format.MediaFormatHandler

When comparing the ratio's of different media formats for automatic rendition generation, use this value as tolerance barrier when comparing ratios of different media formats.

refProperty(String) - Method in interface io.wcm.handler.media.MediaBuilder

Sets the name of the property from which the media reference path is read, or node name for inline media.

refProperty(String) - Method in class io.wcm.handler.media.MediaRequest.MediaPropertyNames

Set media reference property name.

Rendition - Interface in io.wcm.handler.media

Represents a rendition contained in a Asset which can be rendered.

renditionGroup(String) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set rendition group.

resolveLink(String, String, Resource) - Method in interface io.wcm.handler.media.spi.ImageMapLinkResolver

Resolve link.

resolveMedia(Media) - Method in class io.wcm.handler.media.spi.MediaSource

Resolves a media request

resolveMedia(Media) - Method in class io.wcm.handler.mediasource.dam.DamMediaSource

resolveMedia(Media) - Method in class io.wcm.handler.mediasource.inline.InlineMediaSource

resolveMedia(Media) - Method in class io.wcm.handler.mediasource.ngdm.NextGenDynamicMediaMediaSource

resolveRenditions(Media, Asset, MediaArgs) - Method in class io.wcm.handler.media.spi.MediaSource

Resolves single rendition (or multiple renditions if any of the MediaArgs.MediaFormatOption.isMandatory() is set to true and sets the resolved rendition and the URL of the first (best-matching) rendition in the media object.

ResourceMedia - Class in io.wcm.handler.media.ui

Generic resource-based media model.

ResourceMedia() - Constructor for class io.wcm.handler.media.ui.ResourceMedia

rotationProperty(String) - Method in interface io.wcm.handler.media.MediaBuilder

Set the name of the property which contains the rotation parameter.

rotationProperty(String) - Method in class io.wcm.handler.media.MediaRequest.MediaPropertyNames

Set rotation property name.

S

SCALE_HEIGHT - Enum constant in enum class io.wcm.handler.media.UriTemplateType

URI template for building an asset rendition with {height} parameter, resizing the image to the given height.

SCALE_WIDTH - Enum constant in enum class io.wcm.handler.media.UriTemplateType

URI template for building an asset rendition with {width} parameter, resizing the image to the given width.

setAdditionalAttributes(HtmlElement, Media) - Method in class io.wcm.handler.media.markup.AbstractImageMediaMarkupBuilder

Set additional attributes on the media element from the MediaArgs properties.

setAsset(Asset) - Method in class io.wcm.handler.media.Media

Set media item that was resolved during media handler processing

setCropDimension(CropDimension) - Method in class io.wcm.handler.media.Media

Set crop dimensions.

setCustomIPECropRatios(HtmlElement, MediaRequest) - Method in class io.wcm.handler.media.spi.MediaSource

Sets list of cropping ratios to a list matching the selected media formats.

setCustomIPECropRatios(HtmlElement, MediaRequest) - Method in class io.wcm.handler.mediasource.dam.DamMediaSource

setElementBuilder(Function<Media, HtmlElement>) - Method in class io.wcm.handler.media.Media

Set function that builds the HTML element representation on demand.

setMap(List<ImageMapArea>) - Method in class io.wcm.handler.media.Media

Set image map.

setMediaInvalidReason(MediaInvalidReason) - Method in class io.wcm.handler.media.Media

Set reason why the requested media could not be resolved.

setMediaInvalidReasonCustomMessage(String) - Method in class io.wcm.handler.media.Media

Set custom message when media invalid reason is CUSTOM.

setMediaRequest(MediaRequest) - Method in class io.wcm.handler.media.Media

Set media handling request.

setRenditions(Collection<Rendition>) - Method in class io.wcm.handler.media.Media

Set all renditions that was resolved during media handler processing

setRotation(Integer) - Method in class io.wcm.handler.media.Media

Set image rotation.

setUrl(String) - Method in class io.wcm.handler.media.Media

Set media URL.

SimpleImageMediaMarkupBuilder - Class in io.wcm.handler.media.markup

Basic implementation of MediaMarkupBuilder for images.

SimpleImageMediaMarkupBuilder() - Constructor for class io.wcm.handler.media.markup.SimpleImageMediaMarkupBuilder

sizes(String) - Method in class io.wcm.handler.media.MediaArgs.PictureSource

Set source size list.

SVG - Enum constant in enum class io.wcm.handler.media.MediaFileType

SVG

T

THUMBNAIL_RENDITION - Enum constant in enum class io.wcm.handler.mediasource.dam.AemRenditionType

Thumbnail rendition (with cq5dam.thumbnail. prefix).

TIFF - Enum constant in enum class io.wcm.handler.media.MediaFileType

TIFF

toString() - Method in class io.wcm.handler.media.CropDimension

toString() - Method in class io.wcm.handler.media.Dimension

toString() - Method in class io.wcm.handler.media.format.MediaFormat

toString() - Method in class io.wcm.handler.media.Media

toString() - Method in class io.wcm.handler.media.MediaArgs.ImageSizes

toString() - Method in class io.wcm.handler.media.MediaArgs.MediaFormatOption

toString() - Method in class io.wcm.handler.media.MediaArgs.PictureSource

toString() - Method in class io.wcm.handler.media.MediaArgs

toString() - Method in class io.wcm.handler.media.MediaArgs.WidthOption

toString() - Method in class io.wcm.handler.media.MediaRequest.MediaPropertyNames

toString() - Method in class io.wcm.handler.media.MediaRequest

toString() - Method in class io.wcm.handler.mediasource.dam.DamMediaSource

toString() - Method in class io.wcm.handler.mediasource.inline.InlineMediaSource

U

updateMediaArgsFromResource(MediaArgs, Resource, MediaHandlerConfig) - Method in class io.wcm.handler.media.spi.MediaSource

Updates media args settings that have default default values with values defined in the current resource that defines the media reference (e.g. alt. text settings).

URI_TEMPLATE_PLACEHOLDER_HEIGHT - Static variable in class io.wcm.handler.media.MediaNameConstants

URI template placeholder for height.

URI_TEMPLATE_PLACEHOLDER_WIDTH - Static variable in class io.wcm.handler.media.MediaNameConstants

URI template placeholder for width.

UriTemplate - Interface in io.wcm.handler.media

Describes an URI template returned for a given asset.

UriTemplateType - Enum Class in io.wcm.handler.media

Defines the type of URI template to generate.

urlMode(UrlMode) - Method in interface io.wcm.handler.media.MediaBuilder

Set URL mode.

urlMode(UrlMode) - Method in class io.wcm.handler.media.MediaArgs

Set URL mode.

useAdobeStandardNames() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig

With this switch it's possible to switch all used property and node names from (legacy) wcm.io Handler standard to Adobe Standard (as used e.g. in Adobe Core WCM Components) - e.g.

V

valueOf(String) - Static method in enum class io.wcm.handler.media.markup.DragDropSupport

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.wcm.handler.media.markup.IPERatioCustomize

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.wcm.handler.media.MediaFileType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.wcm.handler.media.MediaInvalidReason

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.wcm.handler.media.UriTemplateType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.wcm.handler.mediasource.dam.AemRenditionType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.wcm.handler.media.markup.DragDropSupport

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.wcm.handler.media.markup.IPERatioCustomize

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.wcm.handler.media.MediaFileType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.wcm.handler.media.MediaInvalidReason

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.wcm.handler.media.UriTemplateType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.wcm.handler.mediasource.dam.AemRenditionType

Returns an array containing the constants of this enum class, in the order they are declared.

VIDEO_RENDITION - Enum constant in enum class io.wcm.handler.mediasource.dam.AemRenditionType

Video rendition (with cq5dam.video. prefix).

W

WEB_RENDITION - Enum constant in enum class io.wcm.handler.mediasource.dam.AemRenditionType

Web rendition for the image editor/cropping (with cq5dam.web. prefix).

webOptimizedImageDeliveryDisabled(boolean) - Method in class io.wcm.handler.media.MediaArgs

Set whether web-optimized image delivery is disabled.

webOptimizedImageDeliveryDisabled(boolean) - Method in interface io.wcm.handler.media.MediaBuilder

Disable web-optimized image delivery.

width(long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set fixed image width.

width(long, long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

Set image width range.

WidthOption(long) - Constructor for class io.wcm.handler.media.MediaArgs.WidthOption

Create width option with mandatory width.

WidthOption(long, boolean) - Constructor for class io.wcm.handler.media.MediaArgs.WidthOption

Create width option with optional mandatory flag.

WidthOption(long, String) - Constructor for class io.wcm.handler.media.MediaArgs.WidthOption

Create width option with mandatory width and density.

WidthOption(long, String, boolean) - Constructor for class io.wcm.handler.media.MediaArgs.WidthOption

Create width option with all parameters.

widthOptions(MediaArgs.WidthOption...) - Method in class io.wcm.handler.media.MediaArgs.PictureSource

Set width options for renditions.

widths(long...) - Method in class io.wcm.handler.media.MediaArgs.PictureSource

Set widths for renditions.

A B C D E F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form