Class DummyResponsiveImageMediaMarkupBuilder

  • All Implemented Interfaces:
    MediaMarkupBuilder

    @Model(adaptables={org.apache.sling.api.SlingHttpServletRequest.class,org.apache.sling.api.resource.Resource.class})
    @ConsumerType
    @Deprecated
    public class DummyResponsiveImageMediaMarkupBuilder
    extends AbstractImageMediaMarkupBuilder
    Deprecated.
    Use responsive image handling methods for image sizes and picture sources from MediaBuilder.
    Generates a rendered dummy image as edit placeholder in WCM edit mode with information about image sizes and media format name.
    • Constructor Detail

      • DummyResponsiveImageMediaMarkupBuilder

        public DummyResponsiveImageMediaMarkupBuilder()
        Deprecated.
    • Method Detail

      • accepts

        public final boolean accepts​(@NotNull
                                     @NotNull Media media)
        Deprecated.
        Description copied from interface: MediaMarkupBuilder
        Checks whether this builder can generate markup for the given media.
        Parameters:
        media - Media metadata
        Returns:
        true if this markup builder can handle the given media
      • build

        public final io.wcm.handler.commons.dom.HtmlElement<?> build​(@NotNull
                                                                     @NotNull Media media)
        Deprecated.
        Description copied from interface: MediaMarkupBuilder
        Build media element markup
        Parameters:
        media - Media metadata
        Returns:
        Media element or null if media is invalid
      • getImageElement

        protected io.wcm.handler.commons.dom.HtmlElement<?> getImageElement​(Media media)
        Deprecated.
        Create an IMG element.
        Parameters:
        media - Media metadata
        Returns:
        IMG element with properties
      • getResponsiveImageSources

        protected org.apache.sling.commons.json.JSONArray getResponsiveImageSources​(Media media)
        Deprecated.
        Collect responsive JSON metadata for all renditions as image sources.
        Parameters:
        media - Media
        Returns:
        JSON metadata
      • toReponsiveImageSource

        protected org.apache.sling.commons.json.JSONObject toReponsiveImageSource​(Media media,
                                                                                  MediaFormat mediaFormat)
        Deprecated.
        Build JSON metadata for one rendition as image source.
        Parameters:
        media - Media
        mediaFormat - Media format
        Returns:
        JSON metadata
      • buildDummyImageUrl

        protected final java.lang.String buildDummyImageUrl​(MediaFormat format)
        Deprecated.
        Build Dummy/Placeholder image URL
        Parameters:
        format - Media format
        Returns:
        Dummy image URL
      • setResponsiveImageSource

        protected void setResponsiveImageSource​(io.wcm.handler.commons.dom.HtmlElement<?> mediaElement,
                                                org.apache.sling.commons.json.JSONArray responsiveImageSources,
                                                Media media)
        Deprecated.
        Set attribute on media element for responsive image sources
        Parameters:
        mediaElement - Media element
        responsiveImageSources - Responsive image sources JSON metadata
        media - Media
      • isValidMedia

        public final boolean isValidMedia​(@NotNull
                                          @NotNull io.wcm.handler.commons.dom.HtmlElement<?> element)
        Deprecated.
        Description copied from interface: MediaMarkupBuilder
        Checks if the given HTML element is valid. It is treated as invalid if it is null, or if it is a simple IMG element containing the dummy image.
        Parameters:
        element - Media markup element.
        Returns:
        true if media element is invalid