Package org.ametys.web.skin

Class ImageCropPreviewsComponent

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.skin.ImageCropPreviewsComponent

All Implemented Interfaces:

FileReloader, LogEnabled, Initializable, Component, Serviceable

public class ImageCropPreviewsComponent
extends AbstractLogEnabled
implements Component, Initializable, Serviceable, FileReloader

Component to get the crop image previews brought by the skins

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ImageCropPreviewsComponent.ImageCropPreview	Represents a preview for an image crop, with its dimensions, label and content types conditions

Field Summary

Fields

Modifier and Type	Field	Description
protected SkinsManager	_skinsManager	The skins manager
protected SourceResolver	_srcResolver	The source resolver

Constructor Summary

Constructors

Constructor	Description
ImageCropPreviewsComponent()

Method Summary

Modifier and Type	Method	Description
protected void	_createCaches()	Creates the caches
List<ImageCropPreviewsComponent.ImageCropPreview>	getCropPreviews(String skinName)	Get the list of ImageCropPreviewsComponent.ImageCropPreview defined by the skin
List<Map<String,Object>>	getCropPreviewsForContent(String contentId)	Get the image crop previews defined by the current skin for a given content
String	getId(String sourceUrl)	Get an unique ID for this File Reloader
void	initialize()
void	service(ServiceManager smanager)
void	updateFile(String sourceUrl, Source source, InputStream is)	Update the file, the sourceUrl is only there if you manage multiple files, the Configuration object is already present to read it

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

_skinsManager

protected SkinsManager _skinsManager

The skins manager

_srcResolver

protected SourceResolver _srcResolver

The source resolver

Constructor Details

ImageCropPreviewsComponent

public ImageCropPreviewsComponent()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

_createCaches

protected void _createCaches()

Creates the caches

getCropPreviewsForContent

public List<Map<String,Object>> getCropPreviewsForContent(String contentId)

Get the image crop previews defined by the current skin for a given content

Parameters:

contentId - the content id

Returns:

the image crop previews as json

getCropPreviews

public List<ImageCropPreviewsComponent.ImageCropPreview> getCropPreviews(String skinName)

Get the list of ImageCropPreviewsComponent.ImageCropPreview defined by the skin

Parameters:

skinName - The skin name

Returns:

The list of ImageCropPreviewsComponent.ImageCropPreview

updateFile

public void updateFile(String sourceUrl,
 Source source,
 InputStream is)
                throws Exception

Description copied from interface: FileReloader

Update the file, the sourceUrl is only there if you manage multiple files, the Configuration object is already present to read it

Specified by:

updateFile in interface FileReloader

Parameters:

sourceUrl - the url of the file.

source - the source to read, can be null if no file was read

is - the input stream to read, can be null if no file was read

Throws:

Exception - something went wrong while reading the inputstream

getId

public String getId(String sourceUrl)

Description copied from interface: FileReloader

Get an unique ID for this File Reloader

Specified by:

getId in interface FileReloader

Parameters:

sourceUrl - this is passed as an argument if your class read multiple files. If it reads only one file, the full class name can be a good enough ID

Returns:

an unique ID