Index (Media Handler 2.3.1-SNAPSHOT API)

A B C D E F G H I J L M N O P R S T U V W
All Classes All Packages

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 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
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 - io.wcm.handler.media.markup.DragDropSupport: Always apply drag&drop support (if the media markup builder and media source implemention permit it).
ALWAYS - 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 - io.wcm.handler.media.markup.DragDropSupport: Check via heuristics if drag&drop should be supported.
AUTO - 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
autoCrop(boolean) - Method in interface io.wcm.handler.media.MediaBuilder

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
contentDispositionAttachment(boolean) - Method in interface io.wcm.handler.media.MediaBuilder
create(String) - Static method in class io.wcm.handler.media.format.MediaFormatBuilder: Create a new media format builder.
CROP_CENTER - 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
CropDimension(long, long, long, long, boolean) - Constructor for class io.wcm.handler.media.CropDimension
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
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 - 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
decorative(boolean) - Method in interface io.wcm.handler.media.MediaBuilder
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
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
download(boolean) - Method in class io.wcm.handler.media.format.MediaFormatBuilder
download(boolean) - Method in class io.wcm.handler.media.MediaArgs
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 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
dummyImage(boolean) - Method in interface io.wcm.handler.media.MediaBuilder
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
dummyImageUrl(String) - Method in class io.wcm.handler.media.MediaArgs
dynamicMediaDisabled(boolean) - Method in class io.wcm.handler.media.MediaArgs
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

F

fileExtension(String) - Method in interface io.wcm.handler.media.MediaBuilder
fileExtension(String) - Method in class io.wcm.handler.media.MediaArgs
fileExtensions(String...) - Method in interface io.wcm.handler.media.MediaBuilder
fileExtensions(String...) - Method in class io.wcm.handler.media.MediaArgs
fileSizeMax(long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder
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
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
forceAltValueFromAsset(boolean) - Method in interface io.wcm.handler.media.MediaBuilder
forRendition(Rendition) - Static method in enum io.wcm.handler.mediasource.dam.AemRenditionType
forRendition(String) - Static method in enum io.wcm.handler.mediasource.dam.AemRenditionType
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, Resource) - 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(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
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
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
getBottom() - Method in class io.wcm.handler.media.CropDimension
getBrowserImageContentTypes() - Static method in enum io.wcm.handler.media.MediaFileType
getBrowserImageFileExtensions() - Static method in enum io.wcm.handler.media.MediaFileType
getByContentType(String) - Static method in enum io.wcm.handler.media.MediaFileType: Get Media file type by content type.
getByFileExtensions(String) - Static method in enum 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
getContentTypes() - Method in enum io.wcm.handler.media.MediaFileType
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
getCropProperty() - Method in class io.wcm.handler.media.MediaRequest.MediaPropertyNames
getCropString() - Method in class io.wcm.handler.media.CropDimension
getCropStringWidthHeight() - Method in class io.wcm.handler.media.CropDimension
getDamAsset(Media) - Method in class io.wcm.handler.mediasource.dam.markup.DamVideoMediaMarkupBuilder
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.
getDescription() - Method in interface io.wcm.handler.media.Asset
getDescription() - Method in class io.wcm.handler.media.format.MediaFormat
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
getEffectiveMaxHeight() - Method in class io.wcm.handler.media.format.MediaFormat
getEffectiveMaxWidth() - Method in class io.wcm.handler.media.format.MediaFormat
getEffectiveMinHeight() - Method in class io.wcm.handler.media.format.MediaFormat
getEffectiveMinWidth() - Method in class io.wcm.handler.media.format.MediaFormat
getElement() - Method in class io.wcm.handler.media.Media
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
getExtensions() - Method in enum io.wcm.handler.media.MediaFileType
getFileExtension() - Method in interface io.wcm.handler.media.Rendition
getFileExtensions() - Method in class io.wcm.handler.media.MediaArgs
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
getFileSize() - Method in interface io.wcm.handler.media.Rendition
getFileSizeMax() - Method in class io.wcm.handler.media.format.MediaFormat
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
getHeight() - Method in class io.wcm.handler.media.format.MediaFormat
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
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 io.wcm.handler.media.MediaFileType
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 io.wcm.handler.media.MediaFileType
getImageQualityPercentage() - Method in class io.wcm.handler.media.MediaArgs
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
getImageSizes() - Method in class io.wcm.handler.media.MediaComponentPropertyResolver
getIncludeAssetAemRenditions() - Method in class io.wcm.handler.media.MediaArgs
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
getLabel() - Method in class io.wcm.handler.media.format.MediaFormat
getLeft() - Method in class io.wcm.handler.media.CropDimension
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
getMap() - Method in class io.wcm.handler.media.Media
getMapProperty() - Method in class io.wcm.handler.media.MediaRequest.MediaPropertyNames
getMarkup() - Method in class io.wcm.handler.media.Media
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
getMaxHeight() - Method in class io.wcm.handler.media.format.MediaFormat
getMaxHeight() - Method in interface io.wcm.handler.media.UriTemplate
getMaxWidth() - Method in class io.wcm.handler.media.format.MediaFormat
getMaxWidth() - Method in interface io.wcm.handler.media.UriTemplate
getMedia() - Method in class io.wcm.handler.media.MediaArgs.PictureSource
getMediaAltTextProperty() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig
getMediaArgs() - Method in class io.wcm.handler.media.MediaRequest
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
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
getMediaFormat() - Method in class io.wcm.handler.media.MediaArgs.MediaFormatOption
getMediaFormat() - Method in class io.wcm.handler.media.MediaArgs.PictureSource
getMediaFormat() - Method in interface io.wcm.handler.media.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
getMediaFormatName() - Method in class io.wcm.handler.media.MediaArgs.PictureSource
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
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
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
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
getMediaInvalidReason() - Method in class io.wcm.handler.media.Media
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
getMediaIsDecorativeProperty() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig
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
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
getMediaRef() - Method in class io.wcm.handler.media.MediaRequest
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
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
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
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
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
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
getMinWidth() - Method in class io.wcm.handler.media.format.MediaFormat
getMinWidthHeight() - Method in class io.wcm.handler.media.format.MediaFormat
getModificationDate() - Method in interface io.wcm.handler.media.Rendition
getName() - Method in class io.wcm.handler.media.format.MediaFormat
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
getPictureSources() - Method in class io.wcm.handler.media.MediaComponentPropertyResolver
getPostProcessors() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig
getPreProcessors() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig
getPrimaryMediaRefProperty() - Method in class io.wcm.handler.media.spi.MediaSource
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
getProperties() - Method in class io.wcm.handler.media.format.MediaFormat
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
getRanking() - Method in class io.wcm.handler.media.format.MediaFormat
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
getRatioWidthAsDouble() - Method in class io.wcm.handler.media.format.MediaFormat
getRectangle() - Method in class io.wcm.handler.media.CropDimension
getRefProperty() - Method in class io.wcm.handler.media.MediaRequest.MediaPropertyNames
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
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
getResource() - Method in class io.wcm.handler.media.MediaRequest
getResourceProperties() - Method in class io.wcm.handler.media.MediaRequest
getRight() - Method in class io.wcm.handler.media.CropDimension
getRotation() - Method in class io.wcm.handler.media.Media
getRotationProperty() - Method in class io.wcm.handler.media.MediaRequest.MediaPropertyNames
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
getSizes() - Method in class io.wcm.handler.media.MediaArgs.PictureSource
getSources() - Method in class io.wcm.handler.media.spi.MediaHandlerConfig
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.
getTitle() - Method in interface io.wcm.handler.media.Asset
getTop() - Method in class io.wcm.handler.media.CropDimension
getType() - Method in interface io.wcm.handler.media.UriTemplate
getUriTemplate() - Method in interface io.wcm.handler.media.UriTemplate
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
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
getVectorImageContentTypes() - Static method in enum io.wcm.handler.media.MediaFileType
getVectorImageFileExtensions() - Static method in enum io.wcm.handler.media.MediaFileType
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
getWidth() - Method in class io.wcm.handler.media.Dimension
getWidth() - Method in class io.wcm.handler.media.format.MediaFormat
getWidth() - Method in class io.wcm.handler.media.MediaArgs.WidthOption
getWidth() - Method in interface io.wcm.handler.media.Rendition: Gets the width of this rendition.
getWidthOptions() - Method in class io.wcm.handler.media.MediaArgs.ImageSizes
getWidthOptions() - Method in class io.wcm.handler.media.MediaArgs.PictureSource
GIF - io.wcm.handler.media.MediaFileType: GIF

H

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
height(long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder
height(long, long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

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
imageQualityPercentage(Double) - Method in class io.wcm.handler.media.MediaArgs
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(MediaArgs.ImageSizes) - Method in class io.wcm.handler.media.MediaArgs
ImageSizes(String, long...) - Constructor for class io.wcm.handler.media.MediaArgs.ImageSizes
ImageSizes(String, MediaArgs.WidthOption...) - Constructor for class io.wcm.handler.media.MediaArgs.ImageSizes
includeAssetAemRenditions(Set<AemRenditionType>) - Method in interface io.wcm.handler.media.MediaBuilder
includeAssetAemRenditions(Set<AemRenditionType>) - Method in class io.wcm.handler.media.MediaArgs
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
invalid() - Method in interface io.wcm.handler.media.MediaHandler: Returns an empty media that is marked as invalid.
INVALID_MEDIA_FORMAT - 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
IPERatioCustomize - Enum 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
isAutoCrop() - Method in class io.wcm.handler.media.MediaArgs
isAutoCrop() - Method in class io.wcm.handler.media.MediaComponentPropertyResolver
isBrowserImage() - Method in interface io.wcm.handler.media.Rendition
isBrowserImage(String) - Static method in enum 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
isDecorative() - Method in class io.wcm.handler.media.MediaArgs
isDownload() - Method in class io.wcm.handler.media.format.MediaFormat
isDownload() - Method in class io.wcm.handler.media.MediaArgs
isDownload() - Method in interface io.wcm.handler.media.Rendition
isDummyImage() - Method in class io.wcm.handler.media.MediaArgs
isDynamicMediaDisabled() - Method in class io.wcm.handler.media.MediaArgs
isEnabled() - Method in class io.wcm.handler.mediasource.ngdm.NextGenDynamicMediaConfigModel
isFallback() - Method in interface io.wcm.handler.media.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
isImage() - Method in class io.wcm.handler.media.format.MediaFormat
isImage() - Method in interface io.wcm.handler.media.Rendition
isImage(String) - Static method in enum 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 io.wcm.handler.media.MediaFileType
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
isMandatory() - Method in class io.wcm.handler.media.MediaArgs.MediaFormatOption
isMandatory() - Method in class io.wcm.handler.media.MediaArgs.WidthOption
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
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
isVectorImage(String) - Static method in enum 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
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 - io.wcm.handler.media.MediaFileType: JPEG

L

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

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
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 io.wcm.handler.mediasource.dam.AemRenditionType
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 io.wcm.handler.mediasource.dam.AemRenditionType
maxHeight(long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder
maxWidth(long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder
media(String) - Method in class io.wcm.handler.media.MediaArgs.PictureSource
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
MEDIA_REFERENCE_INVALID - 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 - 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
MediaArgs(String...) - Constructor for class io.wcm.handler.media.MediaArgs
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
MediaFileType - Enum 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(String, boolean) - Constructor for class io.wcm.handler.media.MediaArgs.MediaFormatOption
MediaFormatOption(MediaFormat, boolean) - Constructor for class io.wcm.handler.media.MediaArgs.MediaFormatOption
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
MediaFormatProvider(Set<MediaFormat>) - Constructor for class io.wcm.handler.media.spi.MediaFormatProvider
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 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(Resource, MediaArgs) - Constructor for class io.wcm.handler.media.MediaRequest
MediaRequest(String, MediaArgs) - Constructor for class io.wcm.handler.media.MediaRequest
MediaRequest(Resource, String, MediaArgs, MediaRequest.MediaPropertyNames) - Constructor for class io.wcm.handler.media.MediaRequest
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
minWidth(long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder
minWidthHeight(long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder

N

NEVER - io.wcm.handler.media.markup.DragDropSupport: Never apply drag&drop support.
NEVER - 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 - io.wcm.handler.media.MediaInvalidReason: No matching rendition: The media item exists, but no rendition matches for the requested media args.
NOT_APPROVED - io.wcm.handler.media.MediaInvalidReason: Media reference is valid, but the media is not approved.
NOT_ENOUGH_MATCHING_RENDITIONS - 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 - 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
PictureSource(String) - Constructor for class io.wcm.handler.media.MediaArgs.PictureSource
pictureSources(MediaArgs.PictureSource...) - Method in class io.wcm.handler.media.MediaArgs
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 - 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
ratio(double) - Method in class io.wcm.handler.media.format.MediaFormatBuilder
ratio(double, double) - Method in class io.wcm.handler.media.format.MediaFormatBuilder
ratio(long, long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder
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
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
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

S

SCALE_HEIGHT - io.wcm.handler.media.UriTemplateType: URI template for building an asset rendition with {height} parameter, resizing the image to the given height.
SCALE_WIDTH - 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
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
setMap(List<ImageMapArea>) - Method in class io.wcm.handler.media.Media
setMediaInvalidReason(MediaInvalidReason) - Method in class io.wcm.handler.media.Media
setMediaInvalidReasonCustomMessage(String) - Method in class io.wcm.handler.media.Media
setMediaRequest(MediaRequest) - Method in class io.wcm.handler.media.Media
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
setUrl(String) - Method in class io.wcm.handler.media.Media
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
SVG - io.wcm.handler.media.MediaFileType: SVG

T

THUMBNAIL_RENDITION - io.wcm.handler.mediasource.dam.AemRenditionType: Thumbnail rendition (with cq5dam.thumbnail. prefix).
TIFF - 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 in io.wcm.handler.media: Defines the type of URI template to generate.
urlMode(UrlMode) - Method in interface io.wcm.handler.media.MediaBuilder
urlMode(UrlMode) - Method in class io.wcm.handler.media.MediaArgs
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 io.wcm.handler.media.markup.DragDropSupport: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.wcm.handler.media.markup.IPERatioCustomize: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.wcm.handler.media.MediaFileType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.wcm.handler.media.MediaInvalidReason: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.wcm.handler.media.UriTemplateType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.wcm.handler.mediasource.dam.AemRenditionType: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.wcm.handler.media.markup.DragDropSupport: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.wcm.handler.media.markup.IPERatioCustomize: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.wcm.handler.media.MediaFileType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.wcm.handler.media.MediaInvalidReason: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.wcm.handler.media.UriTemplateType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.wcm.handler.mediasource.dam.AemRenditionType: Returns an array containing the constants of this enum type, in the order they are declared.
VIDEO_RENDITION - io.wcm.handler.mediasource.dam.AemRenditionType: Video rendition (with cq5dam.video. prefix).

W

WEB_RENDITION - 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
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
width(long, long) - Method in class io.wcm.handler.media.format.MediaFormatBuilder
WidthOption(long, boolean) - Constructor for class io.wcm.handler.media.MediaArgs.WidthOption
widthOptions(MediaArgs.WidthOption...) - Method in class io.wcm.handler.media.MediaArgs.PictureSource
widths(long...) - Method in class io.wcm.handler.media.MediaArgs.PictureSource

A B C D E F G H I J L M N O P R S T U V W
All Classes All Packages