org.carrot2.labs.smartsprites

Class SpriteLayoutProperties

java.lang.Object

org.carrot2.labs.smartsprites.SpriteLayoutProperties

public class SpriteLayoutProperties
extends Object

Represents common sprite layout properties that can be used both in SpriteImageDirective and SpriteReferenceDirective.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpriteLayoutProperties.SpriteAlignment Alignment of the individual image within the sprite image.

Field Summary

Fields

Modifier and Type	Field and Description
SpriteLayoutProperties.SpriteAlignment	alignment Alignment of this individual image
int	marginBottom Bottom margin of the individual image
int	marginLeft Left margin of the individual image
int	marginRight Right margin of the individual image
int	marginTop Top margin of the individual image
static String	PROPERTY_SPRITE_ALIGNMENT
static String	PROPERTY_SPRITE_MARGIN_BOTTOM
static String	PROPERTY_SPRITE_MARGIN_LEFT
static String	PROPERTY_SPRITE_MARGIN_RIGHT
static String	PROPERTY_SPRITE_MARGIN_TOP

Constructor Summary

Constructors

Constructor and Description
SpriteLayoutProperties(SpriteLayoutProperties.SpriteAlignment alignment, int marginLeft, int marginRight, int marginTop, int marginBottom)

Method Summary

Methods

Modifier and Type	Method and Description
static SpriteLayoutProperties	parse(String directiveString, SpriteImageDirective.SpriteImageLayout spriteImageLayout, MessageLog messageCollector) Parses a SpriteLayoutProperties from the provided String logging messages to the provided MessageLog.
static SpriteLayoutProperties	parse(String directiveString, SpriteImageDirective.SpriteImageLayout spriteImageLayout, SpriteLayoutProperties defaults, MessageLog messageCollector) Parses a SpriteLayoutProperties from the provided String, using the provided defaults and 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_ALIGNMENT

public static final String PROPERTY_SPRITE_ALIGNMENT

See Also:

Constant Field Values

PROPERTY_SPRITE_MARGIN_BOTTOM

public static final String PROPERTY_SPRITE_MARGIN_BOTTOM

See Also:

Constant Field Values

PROPERTY_SPRITE_MARGIN_TOP

public static final String PROPERTY_SPRITE_MARGIN_TOP

See Also:

Constant Field Values

PROPERTY_SPRITE_MARGIN_RIGHT

public static final String PROPERTY_SPRITE_MARGIN_RIGHT

See Also:

Constant Field Values

PROPERTY_SPRITE_MARGIN_LEFT

public static final String PROPERTY_SPRITE_MARGIN_LEFT

See Also:

Constant Field Values

alignment

public final SpriteLayoutProperties.SpriteAlignment alignment

Alignment of this individual image

marginLeft

public final int marginLeft

Left margin of the individual image

marginRight

public final int marginRight

Right margin of the individual image

marginTop

public final int marginTop

Top margin of the individual image

marginBottom

public final int marginBottom

Bottom margin of the individual image

Constructor Detail

SpriteLayoutProperties

public SpriteLayoutProperties(SpriteLayoutProperties.SpriteAlignment alignment,
                      int marginLeft,
                      int marginRight,
                      int marginTop,
                      int marginBottom)

Method Detail

parse

public static SpriteLayoutProperties parse(String directiveString,
                           SpriteImageDirective.SpriteImageLayout spriteImageLayout,
                           MessageLog messageCollector)

Parses a SpriteLayoutProperties from the provided String logging messages to the provided MessageLog.

parse

public static SpriteLayoutProperties parse(String directiveString,
                           SpriteImageDirective.SpriteImageLayout spriteImageLayout,
                           SpriteLayoutProperties defaults,
                           MessageLog messageCollector)

Parses a SpriteLayoutProperties from the provided String, using the provided defaults and logging messages to the provided MessageLog.