org.carrot2.labs.smartsprites

Class SpriteImage

java.lang.Object

org.carrot2.labs.smartsprites.SpriteImage

public class SpriteImage
extends Object

A merged sprite image consisting of a number of individual images.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	hasReducedForIe6 Indicates whether this sprite has been also generated in an alpha/color degraded version for IE6;
String	resolvedPath The SpriteImageDirective.imagePath with variables resolved.
String	resolvedPathIe6 The SpriteImageDirective.imagePath with variables resolved and the IE6-specific suffix, null if hasReducedForIe6 is false.
float	scaleRatio The scale to apply to the final sprite's background-size.
BufferedImage	sprite The rendered sprite image bitmap
int	spriteHeight The height of the final sprite.
SpriteImageOccurrence	spriteImageOccurrence SpriteImageOccurrence for which this SpriteImage has been built.
Map<SpriteReferenceOccurrence,SpriteReferenceReplacement>	spriteReferenceReplacements All SpriteReferenceReplacements corresponding to the individual images this sprite image consists of.
int	spriteWidth The width of the final sprite.

Constructor Summary

Constructors

Constructor and Description
SpriteImage(BufferedImage sprite, SpriteImageOccurrence spriteImageOccurrence, Map<SpriteReferenceOccurrence,SpriteReferenceReplacement> spriteReplacements, int width, int height, float scale)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

sprite

public final BufferedImage sprite

The rendered sprite image bitmap

spriteReferenceReplacements

public final Map<SpriteReferenceOccurrence,SpriteReferenceReplacement> spriteReferenceReplacements

All SpriteReferenceReplacements corresponding to the individual images this sprite image consists of.

spriteImageOccurrence

public final SpriteImageOccurrence spriteImageOccurrence

SpriteImageOccurrence for which this SpriteImage has been built.

hasReducedForIe6

public boolean hasReducedForIe6

Indicates whether this sprite has been also generated in an alpha/color degraded version for IE6;

resolvedPath

public String resolvedPath

The SpriteImageDirective.imagePath with variables resolved.

resolvedPathIe6

public String resolvedPathIe6

The SpriteImageDirective.imagePath with variables resolved and the IE6-specific suffix, null if hasReducedForIe6 is false.

spriteWidth

public int spriteWidth

The width of the final sprite.

spriteHeight

public int spriteHeight

The height of the final sprite.

scaleRatio

public float scaleRatio

The scale to apply to the final sprite's background-size.

Constructor Detail

SpriteImage

public SpriteImage(BufferedImage sprite,
           SpriteImageOccurrence spriteImageOccurrence,
           Map<SpriteReferenceOccurrence,SpriteReferenceReplacement> spriteReplacements,
           int width,
           int height,
           float scale)