Uses of Interface
io.wcm.handler.media.MediaBuilder

Packages that use MediaBuilder

Package	Description
io.wcm.handler.media	Media Handler API.

Uses of MediaBuilder in io.wcm.handler.media

Methods in io.wcm.handler.media that return MediaBuilder

Modifier and Type	Method	Description
@NotNull MediaBuilder	MediaBuilder.altText(@NotNull java.lang.String value)	Allows to specify a custom alternative text that is to be used instead of the one defined in the the asset metadata.
@NotNull MediaBuilder	MediaBuilder.args(@NotNull MediaArgs mediaArgs)	Sets additional arguments affection media resolving e.g. media formats.
@NotNull MediaBuilder	MediaBuilder.autoCrop(boolean value)
@NotNull MediaBuilder	MediaBuilder.contentDispositionAttachment(boolean value)
@NotNull MediaBuilder	MediaBuilder.cropProperty(@NotNull java.lang.String cropProperty)	Set the name of the property which contains the cropping parameters.
@NotNull MediaBuilder	MediaBuilder.decorative(boolean value)
@NotNull MediaBuilder	MediaBuilder.dragDropSupport(@NotNull DragDropSupport value)	Drag&Drop support for media builder.
@NotNull MediaBuilder	MediaBuilder.dummyImage(boolean value)
@NotNull MediaBuilder	MediaBuilder.dummyImageUrl(@NotNull java.lang.String value)
@NotNull MediaBuilder	MediaBuilder.dynamicMediaDisabled(boolean value)	Disable dynamic media support.
@NotNull MediaBuilder	MediaBuilder.enforceOutputFileExtension(@NotNull java.lang.String value)	Enforces image file type for renditions.
@NotNull MediaBuilder	MediaBuilder.fileExtension(@NotNull java.lang.String value)
@NotNull MediaBuilder	MediaBuilder.fileExtensions(@NotNull java.lang.String @NotNull ... values)
@NotNull MediaBuilder	MediaBuilder.fixedDimension(long widthValue, long heightValue)	Use fixed dimensions instead of width from media format or original image
@NotNull MediaBuilder	MediaBuilder.fixedHeight(long value)	Use fixed height instead of width from media format or original image
@NotNull MediaBuilder	MediaBuilder.fixedWidth(long value)	Use fixed width instead of width from media format or original image
@NotNull MediaBuilder	MediaBuilder.forceAltValueFromAsset(boolean value)
@NotNull MediaBuilder	MediaHandler.get(@NotNull MediaRequest mediaRequest)	Build media for the given request holding all further request properties.
@NotNull MediaBuilder	MediaHandler.get(@Nullable java.lang.String mediaRef)	Build media which is referenced via its string address.
@NotNull MediaBuilder	MediaHandler.get(@Nullable java.lang.String mediaRef, @NotNull MediaArgs mediaArgs)	Build media which is referenced via its string address.
@NotNull MediaBuilder	MediaHandler.get(@Nullable java.lang.String mediaRef, @Nullable org.apache.sling.api.resource.Resource contextResource)	Build media which is referenced via its string address.
@NotNull MediaBuilder	MediaHandler.get(@Nullable java.lang.String mediaRef, MediaFormat @NotNull ... mediaFormats)	Build media which is referenced via its string address.
@NotNull MediaBuilder	MediaHandler.get(@Nullable org.apache.sling.api.resource.Resource resource)	Build media which is referenced in the resource (as property or inline binary data).
@NotNull MediaBuilder	MediaHandler.get(@Nullable org.apache.sling.api.resource.Resource resource, @NotNull MediaArgs mediaArgs)	Build media which is referenced in the resource (as property or inline binary data).
@NotNull MediaBuilder	MediaHandler.get(@Nullable org.apache.sling.api.resource.Resource resource, MediaFormat @NotNull ... mediaFormats)	Build media which is referenced in the resource (as property or inline binary data).
@NotNull MediaBuilder	MediaBuilder.imageQualityPercentage(@NotNull java.lang.Double value)
@NotNull MediaBuilder	MediaBuilder.imageSizes(@NotNull java.lang.String sizes, long @NotNull ... widths)	Apply responsive image handling for the img element based on the primary media format given.
@NotNull MediaBuilder	MediaBuilder.imageSizes(@NotNull java.lang.String sizes, @NotNull MediaArgs.WidthOption @NotNull ... widthOptions)	Apply responsive image handling for the img element based on the primary media format given.
@NotNull MediaBuilder	MediaBuilder.includeAssetAemRenditions(@NotNull java.util.Set<AemRenditionType> value)
@NotNull MediaBuilder	MediaBuilder.includeAssetThumbnails(boolean value)	Deprecated. Please use includeAssetAemRenditions(Set) instead.
@NotNull MediaBuilder	MediaBuilder.includeAssetWebRenditions(boolean value)	Deprecated. Please use includeAssetAemRenditions(Set) instead.
@NotNull MediaBuilder	MediaBuilder.mandatoryMediaFormatNames(@NotNull java.lang.String @NotNull ... values)	Sets list of media formats to resolve to.
@NotNull MediaBuilder	MediaBuilder.mandatoryMediaFormats(@NotNull MediaFormat @NotNull ... values)	Sets list of media formats to resolve to.
@NotNull MediaBuilder	MediaBuilder.mapProperty(@NotNull java.lang.String mapProperty)	Set the name of the property which contains the image map data.
@NotNull MediaBuilder	MediaBuilder.mediaFormat(@NotNull MediaFormat value)	Sets a single media format to resolve to.
@NotNull MediaBuilder	MediaBuilder.mediaFormatName(@NotNull java.lang.String value)	Sets a single media format to resolve to.
@NotNull MediaBuilder	MediaBuilder.mediaFormatNames(@NotNull java.lang.String @NotNull ... values)	Sets list of media formats to resolve to.
@NotNull MediaBuilder	MediaBuilder.mediaFormatOptions(@NotNull MediaArgs.MediaFormatOption @NotNull ... values)	Sets list of media formats to resolve to.
@NotNull MediaBuilder	MediaBuilder.mediaFormats(@NotNull MediaFormat @NotNull ... values)	Sets list of media formats to resolve to.
@NotNull MediaBuilder	MediaBuilder.mediaFormatsMandatory(boolean value)	If set to true, media handler never returns a dummy image.
@NotNull MediaBuilder	MediaBuilder.pictureSource(@NotNull MediaArgs.PictureSource pictureSource)	Apply responsive image handling using picture and source elements.
@NotNull MediaBuilder	MediaBuilder.property(@NotNull java.lang.String key, @Nullable java.lang.Object value)	Adds a custom property that my be used by application-specific markup builders or processors.
@NotNull MediaBuilder	MediaBuilder.refProperty(@NotNull java.lang.String refProperty)	Sets the name of the property from which the media reference path is read, or node name for inline media.
@NotNull MediaBuilder	MediaBuilder.rotationProperty(@NotNull java.lang.String rotationProperty)	Set the name of the property which contains the rotation parameter.
@NotNull MediaBuilder	MediaBuilder.urlMode(@NotNull io.wcm.handler.url.UrlMode value)
@NotNull MediaBuilder	MediaBuilder.webOptimizedImageDeliveryDisabled(boolean value)	Disable web-optimized image delivery.