org.carrot2.labs.smartsprites

Class SpriteReferenceDirective

java.lang.Object

org.carrot2.labs.smartsprites.SpriteReferenceDirective

public class SpriteReferenceDirective
extends Object

Represents a directive that adds an individual image to a sprite image.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_SPRITE_REF
SpriteLayoutProperties	spriteLayoutProperties Sprite layout properties defined at sprite reference level.
String	spriteRef Sprite id for this individual image

Constructor Summary

Constructors

Constructor and Description
SpriteReferenceDirective(String spriteImageId, SpriteLayoutProperties spriteLayoutProperties)

Method Summary

Methods

Modifier and Type	Method and Description
static SpriteReferenceDirective	parse(String directiveString, Map<String,SpriteImageDirective> spriteImages, MessageLog messageCollector) Parses a SpriteReferenceDirective from the provided String, logging messages to the provided MessageLog.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_SPRITE_REF

public static final String PROPERTY_SPRITE_REF

See Also:

Constant Field Values

spriteRef

public final String spriteRef

Sprite id for this individual image

spriteLayoutProperties

public final SpriteLayoutProperties spriteLayoutProperties

Sprite layout properties defined at sprite reference level.

Constructor Detail

SpriteReferenceDirective

public SpriteReferenceDirective(String spriteImageId,
                        SpriteLayoutProperties spriteLayoutProperties)

Method Detail

parse

public static SpriteReferenceDirective parse(String directiveString,
                             Map<String,SpriteImageDirective> spriteImages,
                             MessageLog messageCollector)

Parses a SpriteReferenceDirective from the provided String, logging messages to the provided MessageLog.