de.innovationgate.wgpublisher.webtml.utils

Class SrcSetCreator

java.lang.Object

de.innovationgate.wgpublisher.webtml.utils.SrcSetCreator

All Implemented Interfaces:

WGAAwareService

public class SrcSetCreator
extends java.lang.Object
implements WGAAwareService

Service to generate the contents of the "srcset" attribute for HTML tags image and picture. This generates srcset for providing different images for different device pixel ratios. The necessary prerequisite for this is that the image served normally is a derivate.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<java.lang.Float>	RATIOS

Constructor Summary

Constructors

Constructor and Description
SrcSetCreator()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	createSrcSet(java.lang.String fileUrl) Deprecated. Use createSrcSet(String, Dimension) instead, so DPRs beyond the original size can be omitted
java.lang.String	createSrcSet(java.lang.String fileUrl, boolean absoluteUrls) Deprecated. Use createSrcSet(String, boolean, Dimension) instead, so DPRs beyond the original size can be omitted
java.lang.String	createSrcSet(java.lang.String fileUrl, boolean absoluteUrls, java.awt.Dimension maxAvailableSize) Create srcset content for the given image URL
java.lang.String	createSrcSet(java.lang.String fileUrl, java.awt.Dimension maxAvailableSize) Create srcset content for the given image URL
java.lang.String	createSrcSet(URLBuilder fileUrl, boolean absoluteUrls) Deprecated. Use createSrcSet(URLBuilder, boolean, Dimension) instead, so DPRs beyond the original size can be omitted
java.lang.String	createSrcSet(URLBuilder fileUrl, boolean absoluteUrls, java.awt.Dimension maxAvailableSize) Create srcset content for the given image URL.
static java.lang.String	createSrcSet(WGA wga, URLBuilder fileUrl, boolean absoluteUrls) Deprecated. Use #createSrcSet(WGA, URLBuilder, boolean, Dimension) instead, so DPRs beyond the original size can be omitted
java.awt.Dimension	getMaxAvailablePosterSize(de.innovationgate.webgate.api.WGContent content, de.innovationgate.webgate.api.WGFileMetaData fileMeta) Creates a dimension object from the given file metadata, representing the maximum size that a poster representation of this file is available.
java.awt.Dimension	getMaxAvailableSize(de.innovationgate.webgate.api.WGContent content, de.innovationgate.webgate.api.WGFileMetaData fileMeta, java.lang.String usage) Creates a dimension object from the given file metadata, representing the maximum size that a visual representation of this file is available.
void	injectWGA(WGA wga) Callback method by which the WGA object is injected

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RATIOS

public static final java.util.List<java.lang.Float> RATIOS

Constructor Detail

SrcSetCreator

public SrcSetCreator()

Method Detail

getMaxAvailableSize

public java.awt.Dimension getMaxAvailableSize(de.innovationgate.webgate.api.WGContent content,
                                     de.innovationgate.webgate.api.WGFileMetaData fileMeta,
                                     java.lang.String usage)
                                       throws de.innovationgate.webgate.api.WGException

Creates a dimension object from the given file metadata, representing the maximum size that a visual representation of this file is available. May be the dimensions of the original file if it is an image.

Parameters:

content - The document holding the file

md - The file metadata of the original file

Usage - of the derivate requested

Returns:

The size of the largest visual representation of the given usage or null if no representation was found.

Throws:

de.innovationgate.webgate.api.WGException

getMaxAvailablePosterSize

public java.awt.Dimension getMaxAvailablePosterSize(de.innovationgate.webgate.api.WGContent content,
                                           de.innovationgate.webgate.api.WGFileMetaData fileMeta)
                                             throws de.innovationgate.webgate.api.WGException

Creates a dimension object from the given file metadata, representing the maximum size that a poster representation of this file is available. May be the dimensions of the original file if it is an image.

Parameters:

content - The document holding the file

md - The file metadata of the original file

Throws:

de.innovationgate.webgate.api.WGException

createSrcSet

public static java.lang.String createSrcSet(WGA wga,
                            URLBuilder fileUrl,
                            boolean absoluteUrls)
                                     throws de.innovationgate.webgate.api.WGException

Deprecated. Use #createSrcSet(WGA, URLBuilder, boolean, Dimension) instead, so DPRs beyond the original size can be omitted

Create srcset content for the given image URL. A static non-service version of the functionality.

Parameters:

wga - A WGA context object

fileUrl - The file URL

absoluteUrls - Indicates if the generated URLs in the srcset should be absolute

Throws:

de.innovationgate.webgate.api.WGException

createSrcSet

public java.lang.String createSrcSet(URLBuilder fileUrl,
                            boolean absoluteUrls,
                            java.awt.Dimension maxAvailableSize)
                              throws de.innovationgate.webgate.api.WGException

Create srcset content for the given image URL.

Parameters:

fileUrl - The file URL

absoluteUrls - Indicates if the generated URLs in the srcset should be absolute

maxAvailableSize - The size of the original image file or the largest poster derivate

Throws:

de.innovationgate.webgate.api.WGException

injectWGA

public void injectWGA(WGA wga)

Description copied from interface: WGAAwareService

Callback method by which the WGA object is injected

Specified by:

injectWGA in interface WGAAwareService

Parameters:

wga - The object used to instantiate the service via WGA.service(Class)

createSrcSet

public java.lang.String createSrcSet(URLBuilder fileUrl,
                            boolean absoluteUrls)
                              throws de.innovationgate.webgate.api.WGException

Deprecated. Use createSrcSet(URLBuilder, boolean, Dimension) instead, so DPRs beyond the original size can be omitted

Create srcset content for the given image URL

Parameters:

fileUrl - A URLBuilder containing the file URL

absoluteUrls - Indicates if the generated URLs in the srcset should be absolute

Throws:

de.innovationgate.webgate.api.WGException

createSrcSet

public java.lang.String createSrcSet(java.lang.String fileUrl,
                            boolean absoluteUrls)
                              throws de.innovationgate.webgate.api.WGException

Deprecated. Use createSrcSet(String, boolean, Dimension) instead, so DPRs beyond the original size can be omitted

Create srcset content for the given image URL

Parameters:

fileUrl - The file URL

absoluteUrls - Indicates if the generated URLs in the srcset should be absolute

Throws:

de.innovationgate.webgate.api.WGException

createSrcSet

public java.lang.String createSrcSet(java.lang.String fileUrl,
                            boolean absoluteUrls,
                            java.awt.Dimension maxAvailableSize)
                              throws de.innovationgate.webgate.api.WGException

Create srcset content for the given image URL

Parameters:

fileUrl - The file URL

absoluteUrls - Indicates if the generated URLs in the srcset should be absolute

maxAvailableSize - The size of the original image file or the largest poster derivate

Throws:

de.innovationgate.webgate.api.WGException

createSrcSet

public java.lang.String createSrcSet(java.lang.String fileUrl)
                              throws de.innovationgate.webgate.api.WGException

Deprecated. Use createSrcSet(String, Dimension) instead, so DPRs beyond the original size can be omitted

Create srcset content for the given image URL

Parameters:

fileUrl - The file URL

Throws:

de.innovationgate.webgate.api.WGException

createSrcSet

public java.lang.String createSrcSet(java.lang.String fileUrl,
                            java.awt.Dimension maxAvailableSize)
                              throws de.innovationgate.webgate.api.WGException

Create srcset content for the given image URL

Parameters:

fileUrl - The file URL

maxAvailableSize - The size of the original image file or the largest poster derivate

Throws:

de.innovationgate.webgate.api.WGException