A B C D E F G H I L M N O P Q R S T U V W

A

add(Message) - Method in class org.carrot2.labs.smartsprites.message.LevelCounterMessageSink

add(Message) - Method in class org.carrot2.labs.smartsprites.message.MemoryMessageSink

add(Message) - Method in interface org.carrot2.labs.smartsprites.message.MessageSink

Adds a Message for further processing/ retrieval.

add(Message) - Method in class org.carrot2.labs.smartsprites.message.PrintStreamMessageSink

addConfiguredFileset(FileSet) - Method in class org.carrot2.labs.smartsprites.ant.SmartSpritesTask

addMessageSink(MessageSink) - Method in class org.carrot2.labs.smartsprites.message.MessageLog

Adds a MessageSink to this log.

alignment - Variable in class org.carrot2.labs.smartsprites.SpriteLayoutProperties

Alignment of this individual image

amd - package amd

Color quantization utilities.

arguments - Variable in class org.carrot2.labs.smartsprites.message.Message

Additional arguments to this message, used to format the human-readable string.

B

BufferedImageUtils - Class in org.carrot2.util

Various utility methods for working with BufferedImages.

buildReplacement(SpriteImageDirective.SpriteImageLayout, int) - Method in class org.carrot2.labs.smartsprites.SpriteReferenceOccurrence

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.

buildSprites() - Method in class org.carrot2.labs.smartsprites.SpriteBuilder

Performs processing for this builder's parameters.

buildSprites(Collection<String>) - Method in class org.carrot2.labs.smartsprites.SpriteBuilder

Performs processing from the list of file paths for this builder's parameters.

C

canonicalize(String, String) - Static method in class org.carrot2.util.FileUtils

Removes useless segments in relative paths, e.g.

canReduceWithoutQualityLoss() - Method in class org.carrot2.util.ColorQuantizer.ColorReductionInfo

Returns true if the image can be saved in a 8-bit indexed color format with 1-bit transparency without quality loss.

changeRoot(String, String, String) - Static method in class org.carrot2.util.FileUtils

Changes the root directory of a file.

CollectionUtils - Class in org.carrot2.util

Various utility methods for working with Collections.

CollectionUtils() - Constructor for class org.carrot2.util.CollectionUtils

ColorQuantizer - Class in org.carrot2.util

A simple utility wrapping the Quantize class to work on BufferedImages and handle transparency.

ColorQuantizer() - Constructor for class org.carrot2.util.ColorQuantizer

ColorQuantizer.ColorReductionInfo - Class in org.carrot2.util

Indicates how many distinct colors an image has, whether it has partial trasparency (alpha channel).

ColorQuantizer.ColorReductionInfo(boolean, int) - Constructor for class org.carrot2.util.ColorQuantizer.ColorReductionInfo

COMPARATOR - Static variable in enum org.carrot2.labs.smartsprites.message.Message.MessageLevel

countDistictColors(BufferedImage) - Static method in class org.carrot2.util.BufferedImageUtils

Returns the number of distinct colors (excluding transparency) in the image.

cssFile - Variable in class org.carrot2.labs.smartsprites.SpriteDirectiveOccurrence

CSS file in which this directive was found

cssPath - Variable in class org.carrot2.labs.smartsprites.message.Message

CSS file to which this message refers or null.

CssProperty - Class in org.carrot2.labs.smartsprites.css

Represents a single CSS property and its value, e.g.

CssProperty(String, String) - Constructor for class org.carrot2.labs.smartsprites.css.CssProperty

CssProperty(String, String, boolean) - Constructor for class org.carrot2.labs.smartsprites.css.CssProperty

CssSyntaxUtils - Class in org.carrot2.labs.smartsprites.css

A few utility methods for processing CSS syntax.

CssSyntaxUtils() - Constructor for class org.carrot2.labs.smartsprites.css.CssSyntaxUtils

D

DEFAULT_CSS_FILE_ENCODING - Static variable in class org.carrot2.labs.smartsprites.SmartSpritesParameters

By default, we'll assume CSS files are UTF-8 encoded

DEFAULT_CSS_FILE_SUFFIX - Static variable in class org.carrot2.labs.smartsprites.SmartSpritesParameters

The default suffix to be added to the generated CSS files.

DEFAULT_LOGGING_LEVEL - Static variable in class org.carrot2.labs.smartsprites.SmartSpritesParameters

The default logging level.

DEFAULT_SPRITE_PNG_DEPTH - Static variable in class org.carrot2.labs.smartsprites.SmartSpritesParameters

By default, we use full color only when necessary

DEFAULT_SPRITE_PNG_IE6 - Static variable in class org.carrot2.labs.smartsprites.SmartSpritesParameters

By default, we don't generate separate sprites for IE6

deleteThrowingExceptions(File...) - Static method in class org.carrot2.util.FileUtils

Attempts to delete the provided filesand throws an IOException in case File.delete() returns false for any of them.

deprecation(Message.MessageType, Object...) - Method in class org.carrot2.labs.smartsprites.message.MessageLog

Logs a warning message to this log.

distictColors - Variable in class org.carrot2.util.ColorQuantizer.ColorReductionInfo

Number of distint colors in the image

drawImage(BufferedImage, BufferedImage, int, int) - Static method in class org.carrot2.util.BufferedImageUtils

Draws image on the canvas placing the top left corner of image at x / y offset from the top left corner of canvas.

E

EnumUtils - Class in org.carrot2.util

Various utility methods for working with Java 5 enum types.

EnumUtils() - Constructor for class org.carrot2.util.EnumUtils

error(Message.MessageType, Object...) - Static method in class org.carrot2.labs.smartsprites.message.Message

error(Message.MessageType, Object...) - Method in class org.carrot2.labs.smartsprites.message.MessageLog

Logs an error message to this log.

execute() - Method in class org.carrot2.labs.smartsprites.ant.SmartSpritesTask

extractProperties(String) - Static method in class org.carrot2.labs.smartsprites.css.CssSyntaxUtils

Extracts CSS properties from the provided String.

extractRules(String, MessageLog) - Static method in class org.carrot2.labs.smartsprites.css.CssSyntaxUtils

Extracts CSS properties from the provided String and logs warnings to the provided MessageLog.

F

FileSystemResourceHandler - Class in org.carrot2.labs.smartsprites.resource

This class defines the resource handler which manage resources from the file system.

FileSystemResourceHandler(String, String, MessageLog) - Constructor for class org.carrot2.labs.smartsprites.resource.FileSystemResourceHandler

Creates a new FileSystemResourceHandler.

FileUtils - Class in org.carrot2.util

Various utility methods for working with Files.

FileUtils() - Constructor for class org.carrot2.util.FileUtils

format - Variable in class org.carrot2.labs.smartsprites.SpriteImageDirective

Format of this sprite image.

G

getCanonicalOrAbsoluteFile(String) - Static method in class org.carrot2.util.FileUtils

Creates a new File from the provided path and attempts to execute File.getCanonicalFile().

getColorReductionInfo(BufferedImage) - Static method in class org.carrot2.util.ColorQuantizer

Returns a ColorQuantizer.ColorReductionInfo for the provided image.

getCssFileEncoding() - Method in class org.carrot2.labs.smartsprites.SmartSpritesParameters

getCssFiles() - Method in class org.carrot2.labs.smartsprites.SmartSpritesParameters

getCssFileSuffix() - Method in class org.carrot2.labs.smartsprites.SmartSpritesParameters

getDistictColors(BufferedImage) - Static method in class org.carrot2.util.BufferedImageUtils

Returns the image's distinct colors in an RGB format, discarding transparency information.

getDistictColors(BufferedImage, int) - Static method in class org.carrot2.util.BufferedImageUtils

Returns the image's distinct colors in an RGB format, discarding transparency information.

getDocumentRootDir() - Method in class org.carrot2.labs.smartsprites.SmartSpritesParameters

getFormattedMessage() - Method in class org.carrot2.labs.smartsprites.message.Message

getInfoCount() - Method in class org.carrot2.labs.smartsprites.message.LevelCounterMessageSink

getLogLevel() - Method in class org.carrot2.labs.smartsprites.SmartSpritesParameters

getOutputDir() - Method in class org.carrot2.labs.smartsprites.SmartSpritesParameters

getRelativeFilePath(String, String) - Static method in class org.carrot2.util.PathUtils

This method can calculate the relative path between two pathes on a file system.

getRequiredHeight(BufferedImage, SpriteImageDirective.SpriteImageLayout) - Method in class org.carrot2.labs.smartsprites.SpriteReferenceOccurrence

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

getRequiredWidth(BufferedImage, SpriteImageDirective.SpriteImageLayout) - Method in class org.carrot2.labs.smartsprites.SpriteReferenceOccurrence

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

getResourceAsInputStream(String) - Method in class org.carrot2.labs.smartsprites.resource.FileSystemResourceHandler

getResourceAsInputStream(String) - Method in interface org.carrot2.labs.smartsprites.resource.ResourceHandler

Returns the resource input stream for the provided path.

getResourceAsOutputStream(String) - Method in class org.carrot2.labs.smartsprites.resource.FileSystemResourceHandler

getResourceAsOutputStream(String) - Method in interface org.carrot2.labs.smartsprites.resource.ResourceHandler

Returns the resource output stream for the provided path.

getResourceAsReader(String) - Method in class org.carrot2.labs.smartsprites.resource.FileSystemResourceHandler

getResourceAsReader(String) - Method in interface org.carrot2.labs.smartsprites.resource.ResourceHandler

Returns the reader for the provided path.

getResourceAsWriter(String) - Method in class org.carrot2.labs.smartsprites.resource.FileSystemResourceHandler

getResourceAsWriter(String) - Method in interface org.carrot2.labs.smartsprites.resource.ResourceHandler

Returns the writer for the provided path.

getResourcePath(String, String) - Method in class org.carrot2.labs.smartsprites.resource.FileSystemResourceHandler

This implementation detects if the resource path starts with a "/" and resolves such resources against the provided SmartSpritesParameters.getDocumentRootDir() directory.

getResourcePath(String, String) - Method in interface org.carrot2.labs.smartsprites.resource.ResourceHandler

Builds a resource path relative to a CSS file resource path.

getRgb(BufferedImage) - Static method in class org.carrot2.util.BufferedImageUtils

Returns a two dimensional array of the image's RGB values, including transparency.

getRootDir() - Method in class org.carrot2.labs.smartsprites.SmartSpritesParameters

getRootDirFile() - Method in class org.carrot2.labs.smartsprites.SmartSpritesParameters

getSpritePngDepth() - Method in class org.carrot2.labs.smartsprites.SmartSpritesParameters

getText() - Method in enum org.carrot2.labs.smartsprites.message.Message.MessageType

Returns a human readable version of this message.

getValue(Map<String, CssProperty>, String) - Static method in class org.carrot2.labs.smartsprites.css.CssSyntaxUtils

Returns the value of a CSS property if it exists, null otherwise.

getValue(String) - Static method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.SpriteImageFormat

getValue(String) - Static method in enum org.carrot2.labs.smartsprites.SpriteLayoutProperties.SpriteAlignment

getWarnCount() - Method in class org.carrot2.labs.smartsprites.message.LevelCounterMessageSink

H

hasCssFiles() - Method in class org.carrot2.labs.smartsprites.SmartSpritesParameters

hasDocumentRootDir() - Method in class org.carrot2.labs.smartsprites.SmartSpritesParameters

hasNonBlankValue(Map<String, CssProperty>, String) - Static method in class org.carrot2.labs.smartsprites.css.CssSyntaxUtils

Returns true if the the provided map contains a property with the specified name that has a non-blank value.

hasOutputDir() - Method in class org.carrot2.labs.smartsprites.SmartSpritesParameters

hasPartialTransparency(BufferedImage) - Static method in class org.carrot2.util.BufferedImageUtils

Returns true if the provided image has partially transparent areas (alpha channel).

hasPartialTransparency - Variable in class org.carrot2.util.ColorQuantizer.ColorReductionInfo

True if the image has partially transparent areas (alpha channel)

hasReducedForIe6 - Variable in class org.carrot2.labs.smartsprites.SpriteImage

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

hasRootDir() - Method in class org.carrot2.labs.smartsprites.SmartSpritesParameters

hasTransparency(BufferedImage) - Static method in class org.carrot2.util.BufferedImageUtils

Returns true if the provided image has any kind of transparent areas

horizontalPosition - Variable in class org.carrot2.labs.smartsprites.SpriteReferenceReplacement

Numeric representation of the horizontal position of this sprite replacement

horizontalPositionString - Variable in class org.carrot2.labs.smartsprites.SpriteReferenceReplacement

String representation of the horizontal position of this sprite replacement

I

ie6Mode - Variable in class org.carrot2.labs.smartsprites.SpriteImageDirective

How IE6 sprites should be handled.

imagePath - Variable in class org.carrot2.labs.smartsprites.SpriteImageDirective

CSS file relative path for this sprite image.

imagePath - Variable in class org.carrot2.labs.smartsprites.SpriteReferenceOccurrence

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

important - Variable in class org.carrot2.labs.smartsprites.css.CssProperty

important - Variable in class org.carrot2.labs.smartsprites.SpriteReferenceOccurrence

Indicates whether the original css property has been marked as important

info(Message.MessageType, Object...) - Method in class org.carrot2.labs.smartsprites.message.MessageLog

Logs an information message to this log.

isFileInParent(File, File) - Static method in class org.carrot2.util.FileUtils

Returns true if file is contained in the parent directory or any parent of the parent directory.

isSpritePngIe6() - Method in class org.carrot2.labs.smartsprites.SmartSpritesParameters

L

layout - Variable in class org.carrot2.labs.smartsprites.SpriteImageDirective

Layout of this sprite image.

level - Variable in class org.carrot2.labs.smartsprites.message.Message

Importance of this message.

LevelCounterMessageSink - Class in org.carrot2.labs.smartsprites.message

Counts the number of messages logged with different levels.

LevelCounterMessageSink() - Constructor for class org.carrot2.labs.smartsprites.message.LevelCounterMessageSink

line - Variable in class org.carrot2.labs.smartsprites.message.Message

Line number to which this message refers, meaningful only if Message.cssPath is not null.

line - Variable in class org.carrot2.labs.smartsprites.SpriteDirectiveOccurrence

Line number on which the directive occurred

log(Message.MessageLevel, Message.MessageType, Object...) - Method in class org.carrot2.labs.smartsprites.message.MessageLog

Logs a message to this log.

M

main(String[]) - Static method in class org.carrot2.labs.smartsprites.SmartSprites

Entry point to SmartSprites.

marginBottom - Variable in class org.carrot2.labs.smartsprites.SpriteLayoutProperties

Bottom margin of the individual image

marginLeft - Variable in class org.carrot2.labs.smartsprites.SpriteLayoutProperties

Left margin of the individual image

marginRight - Variable in class org.carrot2.labs.smartsprites.SpriteLayoutProperties

Right margin of the individual image

marginTop - Variable in class org.carrot2.labs.smartsprites.SpriteLayoutProperties

Top margin of the individual image

matte(BufferedImage, Color) - Static method in class org.carrot2.util.BufferedImageUtils

Performs matting of the source image using matteColor.

matteColor - Variable in class org.carrot2.labs.smartsprites.SpriteImageDirective

Matte color to be used when reducing true alpha channel.

MAX_INDEXED_COLORS - Static variable in class org.carrot2.util.ColorQuantizer

Maximum number of colors in an indexed image, leaving one for transparency

MemoryMessageSink - Class in org.carrot2.labs.smartsprites.message

Collects messages in a List, see MemoryMessageSink.messages.

MemoryMessageSink() - Constructor for class org.carrot2.labs.smartsprites.message.MemoryMessageSink

Message - Class in org.carrot2.labs.smartsprites.message

Represents a processing message, can be an information message or a warning.

Message(Message.MessageLevel, Message.MessageType, String, int, Object...) - Constructor for class org.carrot2.labs.smartsprites.message.Message

Creates a new message, see field descriptions for details.

Message.MessageLevel - Enum in org.carrot2.labs.smartsprites.message

The importance of the message.

Message.MessageType - Enum in org.carrot2.labs.smartsprites.message

Defines all the possible information and warning messages.

MessageLog - Class in org.carrot2.labs.smartsprites.message

Gathers Messages during the runtime of the applications.

MessageLog(MessageSink...) - Constructor for class org.carrot2.labs.smartsprites.message.MessageLog

Creates a MessageLog with the provided MessageSinks.

messages - Variable in class org.carrot2.labs.smartsprites.message.MemoryMessageSink

Contains collected messages.

MessageSink - Interface in org.carrot2.labs.smartsprites.message

Collects Messages for further processing/ retrieval.

mkdirsThrowingExceptions(File) - Static method in class org.carrot2.util.FileUtils

Calls File.mkdirs() on the provided argument and throws an IOException if the call returns false.

N

notice(Message.MessageType, Object...) - Method in class org.carrot2.labs.smartsprites.message.MessageLog

Logs a warning message to this log.

O

org.carrot2.labs.smartsprites - package org.carrot2.labs.smartsprites

Data model classes and CSS sprite building.

org.carrot2.labs.smartsprites.ant - package org.carrot2.labs.smartsprites.ant

CSS parsing utilities.

org.carrot2.labs.smartsprites.css - package org.carrot2.labs.smartsprites.css

SmartSprites Ant task.

org.carrot2.labs.smartsprites.message - package org.carrot2.labs.smartsprites.message

Internal message logging system.

org.carrot2.labs.smartsprites.resource - package org.carrot2.labs.smartsprites.resource

Resource abstraction utilities.

org.carrot2.util - package org.carrot2.util

Various utilities.

P

parameters - Variable in class org.carrot2.labs.smartsprites.SpriteBuilder

This builder's configuration

parameters - Variable in class org.carrot2.labs.smartsprites.SpriteImageBuilder

This builder's configuration

parameters - Variable in class org.carrot2.labs.smartsprites.SpriteImageRenderer

This builder's configuration

parse(String, MessageLog) - Static method in class org.carrot2.labs.smartsprites.SpriteImageDirective

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

parse(String, SpriteImageDirective.SpriteImageLayout, MessageLog) - Static method in class org.carrot2.labs.smartsprites.SpriteLayoutProperties

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

parse(String, SpriteImageDirective.SpriteImageLayout, SpriteLayoutProperties, MessageLog) - Static method in class org.carrot2.labs.smartsprites.SpriteLayoutProperties

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

parse(String, Map<String, SpriteImageDirective>, MessageLog) - Static method in class org.carrot2.labs.smartsprites.SpriteReferenceDirective

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

parseColor(String, MessageLog, Color) - Static method in class org.carrot2.labs.smartsprites.css.CssSyntaxUtils

Parses a hexadecimal format (#fff or #ffffff) of CSS color into a Color object.

PathUtils - Class in org.carrot2.util

This class defines utilities methods helping to determine path-related information such as relative paths.

PathUtils() - Constructor for class org.carrot2.util.PathUtils

pattern - Variable in enum org.carrot2.labs.smartsprites.SpriteImageDirective.SpriteUidType

PrintStreamMessageSink - Class in org.carrot2.labs.smartsprites.message

Outputs logged Messages to the provided PrintStream.

PrintStreamMessageSink(PrintStream) - Constructor for class org.carrot2.labs.smartsprites.message.PrintStreamMessageSink

Creates a PrintStreamMessageSink with the provided printStream and Message.MessageLevel.INFO logging level.

PrintStreamMessageSink(PrintStream, Message.MessageLevel) - Constructor for class org.carrot2.labs.smartsprites.message.PrintStreamMessageSink

Creates a PrintStreamMessageSink with the provided printStream and logging level.

propertiesAsMap(Collection<CssProperty>) - Static method in class org.carrot2.labs.smartsprites.css.CssSyntaxUtils

Converts the provided collection of CSS properties to a Map with keys being property names and values being CssProperty objects.

PROPERTY_SPRITE_ALIGNMENT - Static variable in class org.carrot2.labs.smartsprites.SpriteLayoutProperties

PROPERTY_SPRITE_ID - Static variable in class org.carrot2.labs.smartsprites.SpriteImageDirective

PROPERTY_SPRITE_IE6_MODE - Static variable in class org.carrot2.labs.smartsprites.SpriteImageDirective

PROPERTY_SPRITE_IMAGE_LAYOUT - Static variable in class org.carrot2.labs.smartsprites.SpriteImageDirective

PROPERTY_SPRITE_IMAGE_UID_SUFFIX - Static variable in class org.carrot2.labs.smartsprites.SpriteImageDirective

PROPERTY_SPRITE_IMAGE_URL - Static variable in class org.carrot2.labs.smartsprites.SpriteImageDirective

PROPERTY_SPRITE_MARGIN_BOTTOM - Static variable in class org.carrot2.labs.smartsprites.SpriteLayoutProperties

PROPERTY_SPRITE_MARGIN_LEFT - Static variable in class org.carrot2.labs.smartsprites.SpriteLayoutProperties

PROPERTY_SPRITE_MARGIN_RIGHT - Static variable in class org.carrot2.labs.smartsprites.SpriteLayoutProperties

PROPERTY_SPRITE_MARGIN_TOP - Static variable in class org.carrot2.labs.smartsprites.SpriteLayoutProperties

PROPERTY_SPRITE_MATTE_COLOR - Static variable in class org.carrot2.labs.smartsprites.SpriteImageDirective

PROPERTY_SPRITE_REF - Static variable in class org.carrot2.labs.smartsprites.SpriteReferenceDirective

PROPERTY_SPRITE_SCALE - Static variable in class org.carrot2.labs.smartsprites.SpriteImageDirective

Q

Quantize - Class in amd

(#)Quantize.java 0.90 9/19/00 Adam Doppelt An efficient color quantization algorithm, adapted from the C++ implementation quantize.c in ImageMagick.

Quantize() - Constructor for class amd.Quantize

quantize(BufferedImage) - Static method in class org.carrot2.util.ColorQuantizer

Quantizes the image to ColorQuantizer.MAX_INDEXED_COLORS with white matte for areas with partial transparency (full transparency will be preserved).

quantize(BufferedImage, Color) - Static method in class org.carrot2.util.ColorQuantizer

Quantizes the image to ColorQuantizer.MAX_INDEXED_COLORS with the provided matte Color for areas with partial transparency (full transparency will be preserved).

quantize(BufferedImage, Color, int) - Static method in class org.carrot2.util.ColorQuantizer

Quantizes the image to the provided number of colors with the provided matte Color for areas with partial transparency (full transparency will be preserved).

quantizeImage(int[][], int) - Static method in class amd.Quantize

Reduce the image to the given number of colors.

R

reduce(BufferedImage) - Static method in class org.carrot2.util.ColorQuantizer

Reduces a direct color buffered image to an indexed color one without quality loss.

render(BufferedImage, SpriteImageDirective.SpriteImageLayout, int) - Method in class org.carrot2.labs.smartsprites.SpriteReferenceOccurrence

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

resolvedPath - Variable in class org.carrot2.labs.smartsprites.SpriteImage

The SpriteImageDirective.imagePath with variables resolved.

resolvedPathIe6 - Variable in class org.carrot2.labs.smartsprites.SpriteImage

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

ResourceHandler - Interface in org.carrot2.labs.smartsprites.resource

Defines an abstraction layer for resource (CSS, images) management.

rule - Variable in class org.carrot2.labs.smartsprites.css.CssProperty

S

scaleRatio - Variable in class org.carrot2.labs.smartsprites.SpriteImage

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

scaleRatio - Variable in class org.carrot2.labs.smartsprites.SpriteImageDirective

Scaling ratio to apply to background; default is 1.

setCssFile(String) - Method in class org.carrot2.labs.smartsprites.message.MessageLog

setCssFileEncoding(String) - Method in class org.carrot2.labs.smartsprites.ant.SmartSpritesTask

setCssFileSuffix(String) - Method in class org.carrot2.labs.smartsprites.ant.SmartSpritesTask

setDocumentRootDir(File) - Method in class org.carrot2.labs.smartsprites.ant.SmartSpritesTask

setFailOnLevel(String) - Method in class org.carrot2.labs.smartsprites.ant.SmartSpritesTask

setLine(int) - Method in class org.carrot2.labs.smartsprites.message.MessageLog

Sets current CSS line for this log.

setLogLevel(String) - Method in class org.carrot2.labs.smartsprites.ant.SmartSpritesTask

setOutputDir(File) - Method in class org.carrot2.labs.smartsprites.ant.SmartSpritesTask

setRootDir(File) - Method in class org.carrot2.labs.smartsprites.ant.SmartSpritesTask

setSpritePngDepth(String) - Method in class org.carrot2.labs.smartsprites.ant.SmartSpritesTask

setSpritePngIe6(boolean) - Method in class org.carrot2.labs.smartsprites.ant.SmartSpritesTask

SmartSprites - Class in org.carrot2.labs.smartsprites

The entry class for SmartSprites.

SmartSprites() - Constructor for class org.carrot2.labs.smartsprites.SmartSprites

SmartSpritesParameters - Class in org.carrot2.labs.smartsprites

Contains invocation parameters for SmartSprites, provides methods for validating the parameters.

SmartSpritesParameters() - Constructor for class org.carrot2.labs.smartsprites.SmartSpritesParameters

Creates the parameters with default options and null root dir, before root dir is set, the parameters are invalid.

SmartSpritesParameters(String) - Constructor for class org.carrot2.labs.smartsprites.SmartSpritesParameters

Creates the parameters with most default values.

SmartSpritesParameters(String, List<String>, String, String, Message.MessageLevel, String, SmartSpritesParameters.PngDepth, boolean, String) - Constructor for class org.carrot2.labs.smartsprites.SmartSpritesParameters

Creates the parameters.

SmartSpritesParameters.PngDepth - Enum in org.carrot2.labs.smartsprites

SmartSpritesTask - Class in org.carrot2.labs.smartsprites.ant

Ant task for calling SmartSprites processing.

SmartSpritesTask() - Constructor for class org.carrot2.labs.smartsprites.ant.SmartSpritesTask

sprite - Variable in class org.carrot2.labs.smartsprites.SpriteImage

The rendered sprite image bitmap

SpriteBuilder - Class in org.carrot2.labs.smartsprites

Performs all stages of sprite building.

SpriteBuilder(SmartSpritesParameters, MessageLog) - Constructor for class org.carrot2.labs.smartsprites.SpriteBuilder

Creates a SpriteBuilder with the provided parameters and log.

SpriteBuilder(SmartSpritesParameters, MessageLog, ResourceHandler) - Constructor for class org.carrot2.labs.smartsprites.SpriteBuilder

Creates a SpriteBuilder with the provided parameters and log.

SpriteDirectiveOccurrence - Class in org.carrot2.labs.smartsprites

A base class for SmartSprites directives.

SpriteDirectiveOccurrence(String, int) - Constructor for class org.carrot2.labs.smartsprites.SpriteDirectiveOccurrence

SpriteDirectiveOccurrenceCollector - Class in org.carrot2.labs.smartsprites

Methods for collecting SmartSprites directives from CSS files.

spriteHeight - Variable in class org.carrot2.labs.smartsprites.SpriteImage

The height of the final sprite.

spriteId - Variable in class org.carrot2.labs.smartsprites.SpriteImageDirective

Unique identified of this sprite.

SpriteImage - Class in org.carrot2.labs.smartsprites

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

SpriteImage(BufferedImage, SpriteImageOccurrence, Map<SpriteReferenceOccurrence, SpriteReferenceReplacement>, int, int, float) - Constructor for class org.carrot2.labs.smartsprites.SpriteImage

spriteImage - Variable in class org.carrot2.labs.smartsprites.SpriteReferenceReplacement

Properties of the sprite image this replacement refers to

SpriteImageBuilder - Class in org.carrot2.labs.smartsprites

Lays out and builds sprite images based on the collected SmartSprites directives.

SpriteImageDirective - Class in org.carrot2.labs.smartsprites

Represents a directive that declares an individual sprite image.

SpriteImageDirective(String, String, SpriteImageDirective.SpriteImageLayout, SpriteImageDirective.SpriteImageFormat, SpriteImageDirective.Ie6Mode, Color, SpriteImageDirective.SpriteUidType, float) - Constructor for class org.carrot2.labs.smartsprites.SpriteImageDirective

SpriteImageDirective(String, String, SpriteImageDirective.SpriteImageLayout, SpriteImageDirective.SpriteImageFormat, SpriteImageDirective.Ie6Mode, Color, SpriteImageDirective.SpriteUidType, float, SpriteLayoutProperties) - Constructor for class org.carrot2.labs.smartsprites.SpriteImageDirective

spriteImageDirective - Variable in class org.carrot2.labs.smartsprites.SpriteImageOccurrence

SpriteImageDirective.Ie6Mode - Enum in org.carrot2.labs.smartsprites

Defines supported IE6 support options.

SpriteImageDirective.SpriteImageFormat - Enum in org.carrot2.labs.smartsprites

Defines supported image file formats.

SpriteImageDirective.SpriteImageLayout - Enum in org.carrot2.labs.smartsprites

Defines the layout of this sprite.

SpriteImageDirective.SpriteUidType - Enum in org.carrot2.labs.smartsprites

Defines the UID Generation Mode of this sprite.

spriteImageOccurrence - Variable in class org.carrot2.labs.smartsprites.SpriteImage

SpriteImageOccurrence for which this SpriteImage has been built.

SpriteImageOccurrence - Class in org.carrot2.labs.smartsprites

Describes an occurrence of a SpriteImageDirective in a specific CSS file.

SpriteImageOccurrence(SpriteImageDirective, String, int) - Constructor for class org.carrot2.labs.smartsprites.SpriteImageOccurrence

SpriteImageRenderer - Class in org.carrot2.labs.smartsprites

Applies color quantization to the merged sprite image if required.

spriteLayoutProperties - Variable in class org.carrot2.labs.smartsprites.SpriteImageDirective

Sprite layout properties defined at the sprite image directive level.

SpriteLayoutProperties - Class in org.carrot2.labs.smartsprites

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

SpriteLayoutProperties(SpriteLayoutProperties.SpriteAlignment, int, int, int, int) - Constructor for class org.carrot2.labs.smartsprites.SpriteLayoutProperties

spriteLayoutProperties - Variable in class org.carrot2.labs.smartsprites.SpriteReferenceDirective

Sprite layout properties defined at sprite reference level.

SpriteLayoutProperties.SpriteAlignment - Enum in org.carrot2.labs.smartsprites

Alignment of the individual image within the sprite image.

spriteRef - Variable in class org.carrot2.labs.smartsprites.SpriteReferenceDirective

Sprite id for this individual image

SpriteReferenceDirective - Class in org.carrot2.labs.smartsprites

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

SpriteReferenceDirective(String, SpriteLayoutProperties) - Constructor for class org.carrot2.labs.smartsprites.SpriteReferenceDirective

spriteReferenceDirective - Variable in class org.carrot2.labs.smartsprites.SpriteReferenceOccurrence

The directive

SpriteReferenceOccurrence - Class in org.carrot2.labs.smartsprites

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

SpriteReferenceOccurrence(SpriteReferenceDirective, String, String, int, boolean) - Constructor for class org.carrot2.labs.smartsprites.SpriteReferenceOccurrence

spriteReferenceOccurrence - Variable in class org.carrot2.labs.smartsprites.SpriteReferenceReplacement

The SpriteReferenceOccurrence this instance refers to

SpriteReferenceReplacement - Class in org.carrot2.labs.smartsprites

Represents the replacement that will be made for an individual SpriteReferenceOccurrence.

SpriteReferenceReplacement(SpriteReferenceOccurrence, int, String) - Constructor for class org.carrot2.labs.smartsprites.SpriteReferenceReplacement

SpriteReferenceReplacement(SpriteReferenceOccurrence, String, int) - Constructor for class org.carrot2.labs.smartsprites.SpriteReferenceReplacement

spriteReferenceReplacements - Variable in class org.carrot2.labs.smartsprites.SpriteImage

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

spriteWidth - Variable in class org.carrot2.labs.smartsprites.SpriteImage

The width of the final sprite.

status(Message.MessageType, Object...) - Method in class org.carrot2.labs.smartsprites.message.MessageLog

Logs a status message to this log.

T

toString() - Method in class org.carrot2.labs.smartsprites.message.Message

toString() - Method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.Ie6Mode

toString() - Method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.SpriteImageFormat

toString() - Method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.SpriteImageLayout

toString() - Method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.SpriteUidType

toString() - Method in enum org.carrot2.labs.smartsprites.SpriteLayoutProperties.SpriteAlignment

toString(Collection<?>) - Static method in class org.carrot2.util.CollectionUtils

Converts a Collection to a String separating entries by , .

type - Variable in class org.carrot2.labs.smartsprites.message.Message

Semantics of the message.

U

uidType - Variable in class org.carrot2.labs.smartsprites.SpriteImageDirective

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

unpackUrl(String) - Static method in class org.carrot2.labs.smartsprites.css.CssSyntaxUtils

Extracts the actual url from the CSS url expression like url('actua_url').

unpackUrl(String, MessageLog) - Static method in class org.carrot2.labs.smartsprites.css.CssSyntaxUtils

Extracts the actual url from the CSS url expression like url('actua_url') and logs warnings to the provided MessageLog.

V

validate(MessageLog) - Method in class org.carrot2.labs.smartsprites.SmartSpritesParameters

Validates the provided parameters.

value - Variable in class org.carrot2.labs.smartsprites.css.CssProperty

valueOf(String) - Static method in enum org.carrot2.labs.smartsprites.message.Message.MessageLevel

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.carrot2.labs.smartsprites.message.Message.MessageType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.carrot2.labs.smartsprites.SmartSpritesParameters.PngDepth

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.Ie6Mode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.SpriteImageFormat

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.SpriteImageLayout

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.SpriteUidType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.carrot2.labs.smartsprites.SpriteLayoutProperties.SpriteAlignment

Returns the enum constant of this type with the specified name.

valueOf(String, Class<T>, T) - Static method in class org.carrot2.util.EnumUtils

Returns the enum instance corresponding to the provided name or defaultValue if no enum value corresponds to name.

values() - Static method in enum org.carrot2.labs.smartsprites.message.Message.MessageLevel

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.carrot2.labs.smartsprites.message.Message.MessageType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.carrot2.labs.smartsprites.SmartSpritesParameters.PngDepth

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.Ie6Mode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.SpriteImageFormat

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.SpriteImageLayout

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.SpriteUidType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.carrot2.labs.smartsprites.SpriteLayoutProperties.SpriteAlignment

Returns an array containing the constants of this enum type, in the order they are declared.

valuesAsString() - Static method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.Ie6Mode

valuesAsString() - Static method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.SpriteImageFormat

valuesAsString() - Static method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.SpriteImageLayout

valuesAsString() - Static method in enum org.carrot2.labs.smartsprites.SpriteImageDirective.SpriteUidType

valuesAsString() - Static method in enum org.carrot2.labs.smartsprites.SpriteLayoutProperties.SpriteAlignment

verticalPosition - Variable in class org.carrot2.labs.smartsprites.SpriteReferenceReplacement

Numeric representation of the vertical position of this sprite replacement

verticalPositionString - Variable in class org.carrot2.labs.smartsprites.SpriteReferenceReplacement

String representation of the vertical position of this sprite replacement

W

warn(Message.MessageType, Object...) - Static method in class org.carrot2.labs.smartsprites.message.Message

warning(Message.MessageType, Object...) - Method in class org.carrot2.labs.smartsprites.message.MessageLog

Logs a warning message to this log.

A B C D E F G H I L M N O P Q R S T U V W