com.github.wuic.engine.core

Class JavascriptSpriteProvider

java.lang.Object

com.github.wuic.engine.core.AbstractSpriteProvider

com.github.wuic.engine.core.JavascriptSpriteProvider

All Implemented Interfaces:

SpriteProvider

public class JavascriptSpriteProvider
extends AbstractSpriteProvider

This class provides sprite throughout javascript language. The javascript path defines an array which associates each aggregated image name to its region in the final image.

In Javascript, an object is declared in variable starting with WUIC_SPRITE_ and ending with the heap ID. The heap ID is treated to be in upper case and with its characters which are invalid in javascript variable names replaced with an underscore.

Since:

0.2.0

Version:

1.8

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
JavascriptSpriteProvider()

Method Summary

Methods

Modifier and Type	Method and Description
ConvertibleNut	getSprite(String workflowId, UrlProvider urlProvider, String nutNameSuffix, List<ConvertibleNut> originals) Get the sprite of all the added images in a map associating a NutType as key a Nut as value.

Methods inherited from class com.github.wuic.engine.core.AbstractSpriteProvider

addRegion, convertAllowedName, getImage, getRegions, init

Methods inherited from class java.lang.Object

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

Constructor Detail

JavascriptSpriteProvider

public JavascriptSpriteProvider()

Method Detail

getSprite

public ConvertibleNut getSprite(String workflowId,
                       UrlProvider urlProvider,
                       String nutNameSuffix,
                       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

nutNameSuffix - 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