org.apache.fop.util

Class ColorUtil


public final class ColorUtil
extends java.lang.Object

Generic Color helper class.

This class supports parsing string values into color values and creating color values for strings. It provides a list of standard color names.

Field Summary

protected static Log
log
Logger instance

Method Summary

static String
colorToString(Color color)
Creates a re-parsable string representation of the given color.
static Color
parseColorString(FOUserAgent foUserAgent, String value)
Creates a color from a given string.

Field Details

log

protected static Log log
Logger instance

Method Details

colorToString

public static String colorToString(Color color)
Creates a re-parsable string representation of the given color.

First, the color will be converted into the sRGB colorspace. It will then be printed as #rrggbb, or as #rrrggbbaa if an alpha value is present.

Parameters:
color - the color to represent.
Returns:
a re-parsable string representadion.

parseColorString

public static Color parseColorString(FOUserAgent foUserAgent,
                                     String value)
            throws PropertyException
Creates a color from a given string.

This function supports a wide variety of inputs.

  • #RGB (hex 0..f)
  • #RGBA (hex 0..f)
  • #RRGGBB (hex 00..ff)
  • #RRGGBBAA (hex 00..ff)
  • rgb(r,g,b) (0..255 or 0%..100%)
  • java.awt.Color[r=r,g=g,b=b] (0..255)
  • system-color(colorname)
  • transparent
  • colorname
  • fop-rgb-icc(r,g,b,cs,cs-src,[num]+) (r/g/b: 0..1, num: 0..1)
  • cmyk(c,m,y,k) (0..1)
Parameters:
foUserAgent - FOUserAgent object
value - the string to parse.
Returns:
a Color representing the string if possible
Throws:
PropertyException - if the string is not parsable or does not follow any of the given formats.

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.