com.github.wuic.engine.core

Class AbstractSpriteProvider

java.lang.Object

com.github.wuic.engine.core.AbstractSpriteProvider

All Implemented Interfaces:

SpriteProvider

Direct Known Subclasses:

CssSpriteProvider, JavascriptSpriteProvider

public abstract class AbstractSpriteProvider
extends Object
implements SpriteProvider

Abstraction of the implementation of what is a SpriteProvider.

Since:

0.3.1

Version:

1.1

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
AbstractSpriteProvider() Builds a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRegion(Region region, String name) Registers a new region in the image.
String	convertAllowedName(String heapId, String name) Unified method to use to compute allowed name in sprite declaration.
protected ConvertibleNut	getImage() Gets the image.
protected Map<String,Region>	getRegions() Gets the regions.
void	init(ConvertibleNut nut) Initializes this provider with a new image.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.wuic.engine.SpriteProvider

getSprite

Constructor Detail

AbstractSpriteProvider

public AbstractSpriteProvider()

Builds a new instance.

Method Detail

addRegion

public void addRegion(Region region,
             String name)

Registers a new region in the image.

Specified by:

addRegion in interface SpriteProvider

Parameters:

region - the region

name - the region name

init

public void init(ConvertibleNut nut)

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

Specified by:

init in interface SpriteProvider

Parameters:

nut - the new image

convertAllowedName

public String convertAllowedName(String heapId,
                        String name)

Unified method to use to compute allowed name in sprite declaration.

First of all, the heap ID is concatenated with the name separated by an underscore. The extension and parent path of the name will be removed. Finally, any character which is not a letter (in upper or lower case) will be replaced by an "underscore".

Parameters:

name - the name to use in sprite

Returns:

the name usable in sprites

getRegions

protected Map<String,Region> getRegions()

Gets the regions.

Returns:

teh regions

getImage

protected ConvertibleNut getImage()

Gets the image.

Returns:

the image