org.carrot2.labs.smartsprites

Class SpriteReferenceOccurrence

java.lang.Object

org.carrot2.labs.smartsprites.SpriteDirectiveOccurrence

org.carrot2.labs.smartsprites.SpriteReferenceOccurrence

public class SpriteReferenceOccurrence
extends SpriteDirectiveOccurrence

Represents an occurrence of a SpriteReferenceDirective in a specific CSS file.

Field Summary

Fields

Modifier and Type	Field and Description
String	imagePath CSS file relative path to the individual image to be added to a sprite.
boolean	important Indicates whether the original css property has been marked as important
SpriteReferenceDirective	spriteReferenceDirective The directive

Fields inherited from class org.carrot2.labs.smartsprites.SpriteDirectiveOccurrence

cssFile, line

Constructor Summary

Constructors

Constructor and Description
SpriteReferenceOccurrence(SpriteReferenceDirective spriteReferenceDirective, String imageFile, String cssFile, int line, boolean important)

Method Summary

Methods

Modifier and Type	Method and Description
SpriteReferenceReplacement	buildReplacement(SpriteImageDirective.SpriteImageLayout layout, int offset) Returns the SpriteReferenceReplacement corresponding to the occurrence, taking into account the layout the the enclosing sprite and the offset at which the individual image was rendered.
int	getRequiredHeight(BufferedImage image, SpriteImageDirective.SpriteImageLayout layout) Computes the minimum height the individual image will need when rendering.
int	getRequiredWidth(BufferedImage image, SpriteImageDirective.SpriteImageLayout layout) Computes the minimum width the individual image will need when rendering.
BufferedImage	render(BufferedImage image, SpriteImageDirective.SpriteImageLayout layout, int dimension) Renders the individual image, including margins and repeats if any.

Methods inherited from class java.lang.Object

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

Field Detail

spriteReferenceDirective

public final SpriteReferenceDirective spriteReferenceDirective

The directive

imagePath

public final String imagePath

CSS file relative path to the individual image to be added to a sprite.

important

public final boolean important

Indicates whether the original css property has been marked as important

Constructor Detail

SpriteReferenceOccurrence

public SpriteReferenceOccurrence(SpriteReferenceDirective spriteReferenceDirective,
                         String imageFile,
                         String cssFile,
                         int line,
                         boolean important)

Method Detail

getRequiredWidth

public int getRequiredWidth(BufferedImage image,
                   SpriteImageDirective.SpriteImageLayout layout)

Computes the minimum width the individual image will need when rendering.

getRequiredHeight

public int getRequiredHeight(BufferedImage image,
                    SpriteImageDirective.SpriteImageLayout layout)

Computes the minimum height the individual image will need when rendering.

render

public BufferedImage render(BufferedImage image,
                   SpriteImageDirective.SpriteImageLayout layout,
                   int dimension)

Renders the individual image, including margins and repeats if any.

Parameters:

image - the individual image as read from the file

layout - the layout the enclosing sprite

dimension - height/width of a horizontal/vertical sprite

Returns:

the rendered individual image

buildReplacement

public SpriteReferenceReplacement buildReplacement(SpriteImageDirective.SpriteImageLayout layout,
                                          int offset)

Returns the SpriteReferenceReplacement corresponding to the occurrence, taking into account the layout the the enclosing sprite and the offset at which the individual image was rendered.