com.github.wuic.engine

Interface SpriteProvider

All Known Implementing Classes:

AbstractSpriteProvider, CssSpriteProvider, JavascriptSpriteProvider

public interface SpriteProvider

This interface represents a type of object which provides sprite generation capabilities.

When a set of images is aggregated, then the region of each of them in the generated image is located through a sprite. A sprite could be generated according to specific convention in a chosen language. The implementation of this interface must be able to specify the language through a known NutType.

Since:

0.2.0

Version:

1.4

Author:

Guillaume DROUET

Method Summary

Methods

Modifier and Type	Method and Description
void	addRegion(Region region, String name) Registers a new region in the image.
ConvertibleNut	getSprite(String workflowId, UrlProvider urlProvider, String nutNamePrefix, List<ConvertibleNut> originals) Get the sprite of all the added images in a map associating a NutType as key a Nut as value.
void	init(ConvertibleNut nut) Initializes this provider with a new image.

Method Detail

addRegion

void addRegion(Region region,
             String name)

Registers a new region in the image.

Parameters:

region - the region

name - the region name

getSprite

ConvertibleNut getSprite(String workflowId,
                       UrlProvider urlProvider,
                       String nutNamePrefix,
                       List<ConvertibleNut> originals)
                         throws IOException

Get the sprite of all the added images in a map associating a NutType as key a Nut as value.

Each sprite is in a path associated to a supported NutType which helps to determinate the language used to represent them.

Parameters:

workflowId - the workflow ID

urlProvider - the UrlProvider

nutNamePrefix - the prefix to append to the sprite nut name

originals - the original nuts

Returns:

a nut representing the sprite path

Throws:

IOException - if an I/O error occurs while aggregating images

init

void init(ConvertibleNut nut)

Initializes this provider with a new image. Previous regions will be cleared.

Parameters:

nut - the new image