Package io.wcm.handler.mediasource.inline

Class InlineMediaSource

java.lang.Object

io.wcm.handler.media.spi.MediaSource

io.wcm.handler.mediasource.inline.InlineMediaSource

@Model(adaptables={org.apache.sling.api.SlingHttpServletRequest.class,org.apache.sling.api.resource.Resource.class})
@ProviderType
public final class InlineMediaSource
extends MediaSource

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

Field Summary

Fields

Modifier and Type	Field	Description
static final @NotNull String	ID	Media source ID

Constructor Summary

Constructors

Constructor	Description
InlineMediaSource()

Method Summary

Modifier and Type	Method	Description
boolean	accepts(@NotNull MediaRequest mediaRequest)	Checks whether a media request can be handled by this media source
boolean	accepts(@Nullable String mediaRef)	Checks whether a media request string can be handled by this media source
void	enableMediaDrop(@NotNull io.wcm.handler.commons.dom.HtmlElement element, @NotNull MediaRequest mediaRequest)	Create a drop area for given HTML element to enable drag and drop of DAM assets from content finder to this element.
@NotNull String	getId()	Get media source ID.
@Nullable String	getPrimaryMediaRefProperty()	Get name of the property in which the primary media request is stored.
@NotNull Media	resolveMedia(@NotNull Media media)	Resolves a media request
String	toString()

Methods inherited from class io.wcm.handler.media.spi.MediaSource

getMediaCropDimension, getMediaCropProperty, getMediaMap, getMediaMapProperty, getMediaRef, getMediaRefProperty, getMediaRotation, getMediaRotationProperty, resolveRenditions, setCustomIPECropRatios, updateMediaArgsFromResource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ID

@NotNull
public static final @NotNull String ID

Media source ID

See Also:

• Constant Field Values

Constructor Details

InlineMediaSource

public InlineMediaSource()

Method Details

getId

@NotNull
public @NotNull String getId()

Description copied from class: MediaSource

Get media source ID.

Specified by:

getId in class MediaSource

Returns:

Media source ID

accepts

public boolean accepts(@NotNull
 @NotNull MediaRequest mediaRequest)

Description copied from class: MediaSource

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

Overrides:

accepts in class MediaSource

Parameters:

mediaRequest - Media request

Returns:

true if this media source can handle the given media request

accepts

public boolean accepts(@Nullable
 @Nullable String mediaRef)

Description copied from class: MediaSource

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

Specified by:

accepts in class MediaSource

Parameters:

mediaRef - Media request string

Returns:

true if this media source can handle the given media request

getPrimaryMediaRefProperty

@Nullable
public @Nullable String getPrimaryMediaRefProperty()

Description copied from class: MediaSource

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

Specified by:

getPrimaryMediaRefProperty in class MediaSource

Returns:

Name of the property in which the primary media request is stored

resolveMedia

@NotNull
public @NotNull Media resolveMedia(@NotNull
 @NotNull Media media)

Description copied from class: MediaSource

Resolves a media request

Specified by:

resolveMedia in class MediaSource

Parameters:

media - Media metadata

Returns:

Resolved media metadata. Never null.

enableMediaDrop

public void enableMediaDrop(@NotNull
 @NotNull io.wcm.handler.commons.dom.HtmlElement element,
 @NotNull
 @NotNull MediaRequest mediaRequest)

Description copied from class: MediaSource

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

Specified by:

enableMediaDrop in class MediaSource

Parameters:

element - Html element

mediaRequest - Media request to detect media args and property names

toString

public String toString()

Overrides:

toString in class Object