org.carrot2.labs.smartsprites

Class SpriteImageDirective

java.lang.Object

org.carrot2.labs.smartsprites.SpriteImageDirective

public class SpriteImageDirective
extends Object

Represents a directive that declares an individual sprite image.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpriteImageDirective.Ie6Mode Defines supported IE6 support options.
static class	SpriteImageDirective.SpriteImageFormat Defines supported image file formats.
static class	SpriteImageDirective.SpriteImageLayout Defines the layout of this sprite.
static class	SpriteImageDirective.SpriteUidType Defines the UID Generation Mode of this sprite.

Field Summary

Fields

Modifier and Type	Field and Description
SpriteImageDirective.SpriteImageFormat	format Format of this sprite image.
SpriteImageDirective.Ie6Mode	ie6Mode How IE6 sprites should be handled.
String	imagePath CSS file relative path for this sprite image.
SpriteImageDirective.SpriteImageLayout	layout Layout of this sprite image.
Color	matteColor Matte color to be used when reducing true alpha channel.
static String	PROPERTY_SPRITE_ID
static String	PROPERTY_SPRITE_IE6_MODE
static String	PROPERTY_SPRITE_IMAGE_LAYOUT
static String	PROPERTY_SPRITE_IMAGE_UID_SUFFIX
static String	PROPERTY_SPRITE_IMAGE_URL
static String	PROPERTY_SPRITE_MATTE_COLOR
static String	PROPERTY_SPRITE_SCALE
float	scaleRatio Scaling ratio to apply to background; default is 1.
String	spriteId Unique identified of this sprite.
SpriteLayoutProperties	spriteLayoutProperties Sprite layout properties defined at the sprite image directive level.
SpriteImageDirective.SpriteUidType	uidType Non-file-name extension after the sprite image path to force a cache update on change, prefixed by '?'.

Constructor Summary

Constructors

Constructor and Description
SpriteImageDirective(String id, String imageUrl, SpriteImageDirective.SpriteImageLayout layout, SpriteImageDirective.SpriteImageFormat format, SpriteImageDirective.Ie6Mode ie6Mode, Color matteColor, SpriteImageDirective.SpriteUidType uidType, float scale)
SpriteImageDirective(String id, String imageUrl, SpriteImageDirective.SpriteImageLayout layout, SpriteImageDirective.SpriteImageFormat format, SpriteImageDirective.Ie6Mode ie6Mode, Color matteColor, SpriteImageDirective.SpriteUidType uidType, float scale, SpriteLayoutProperties spriteLayoutProperties)

Method Summary

Methods

Modifier and Type	Method and Description
static SpriteImageDirective	parse(String directiveString, MessageLog messageCollector) Parses a string into a SpriteImageDirective, logging messages to the provided MessageLogs.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_SPRITE_ID

public static final String PROPERTY_SPRITE_ID

See Also:

Constant Field Values

PROPERTY_SPRITE_IMAGE_LAYOUT

public static final String PROPERTY_SPRITE_IMAGE_LAYOUT

See Also:

Constant Field Values

PROPERTY_SPRITE_IMAGE_URL

public static final String PROPERTY_SPRITE_IMAGE_URL

See Also:

Constant Field Values

PROPERTY_SPRITE_IMAGE_UID_SUFFIX

public static final String PROPERTY_SPRITE_IMAGE_UID_SUFFIX

See Also:

Constant Field Values

PROPERTY_SPRITE_MATTE_COLOR

public static final String PROPERTY_SPRITE_MATTE_COLOR

See Also:

Constant Field Values

PROPERTY_SPRITE_IE6_MODE

public static final String PROPERTY_SPRITE_IE6_MODE

See Also:

Constant Field Values

PROPERTY_SPRITE_SCALE

public static final String PROPERTY_SPRITE_SCALE

See Also:

Constant Field Values

spriteId

public final String spriteId

Unique identified of this sprite.

imagePath

public final String imagePath

CSS file relative path for this sprite image.

uidType

public final SpriteImageDirective.SpriteUidType uidType

Non-file-name extension after the sprite image path to force a cache update on change, prefixed by '?'.

layout

public final SpriteImageDirective.SpriteImageLayout layout

Layout of this sprite image.

format

public final SpriteImageDirective.SpriteImageFormat format

Format of this sprite image.

ie6Mode

public final SpriteImageDirective.Ie6Mode ie6Mode

How IE6 sprites should be handled.

matteColor

public final Color matteColor

Matte color to be used when reducing true alpha channel.

scaleRatio

public final float scaleRatio

Scaling ratio to apply to background; default is 1.

spriteLayoutProperties

public final SpriteLayoutProperties spriteLayoutProperties

Sprite layout properties defined at the sprite image directive level. The defaults provided here can be overridden at the sprite reference directive level.

Constructor Detail

SpriteImageDirective

public SpriteImageDirective(String id,
                    String imageUrl,
                    SpriteImageDirective.SpriteImageLayout layout,
                    SpriteImageDirective.SpriteImageFormat format,
                    SpriteImageDirective.Ie6Mode ie6Mode,
                    Color matteColor,
                    SpriteImageDirective.SpriteUidType uidType,
                    float scale)

SpriteImageDirective

public SpriteImageDirective(String id,
                    String imageUrl,
                    SpriteImageDirective.SpriteImageLayout layout,
                    SpriteImageDirective.SpriteImageFormat format,
                    SpriteImageDirective.Ie6Mode ie6Mode,
                    Color matteColor,
                    SpriteImageDirective.SpriteUidType uidType,
                    float scale,
                    SpriteLayoutProperties spriteLayoutProperties)

Method Detail

parse

public static SpriteImageDirective parse(String directiveString,
                         MessageLog messageCollector)

Parses a string into a SpriteImageDirective, logging messages to the provided MessageLogs.