Package org.apache.fop.fo.properties

Class ColorProperty

java.lang.Object

org.apache.fop.fo.properties.Property

org.apache.fop.fo.properties.ColorProperty

public final class ColorProperty
extends Property

Class for properties that wrap Color values

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ColorProperty.Maker	Inner class for creating instances of ColorTypeProperty

Field Summary

Fields

Modifier and Type	Field	Description
private static PropertyCache<ColorProperty>	CACHE	cache holding canonical ColorProperty instances
private java.awt.Color	color	The color represented by this property.

Fields inherited from class org.apache.fop.fo.properties.Property

log

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ColorProperty(java.awt.Color value)	Create a new ColorProperty with a given color.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.awt.Color	getColor(FOUserAgent foUserAgent)	Returns an AWT instance of this color
ColorProperty	getColorProperty()	Can't convert to any other types
static ColorProperty	getInstance(FOUserAgent foUserAgent, java.lang.String value)	Set the color given a particular String.
java.lang.Object	getObject()	This method expects to be overridden by subclasses
int	hashCode()
java.lang.String	toString()

Methods inherited from class org.apache.fop.fo.properties.Property

getCharacter, getCondLength, getEnum, getKeep, getLength, getLengthPair, getLengthRange, getList, getNCname, getNumber, getNumeric, getSpace, getSpecifiedValue, getString, isAuto, setSpecifiedValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CACHE

private static final PropertyCache<ColorProperty> CACHE

cache holding canonical ColorProperty instances

color

private final java.awt.Color color

The color represented by this property.

Constructor Detail

ColorProperty

private ColorProperty(java.awt.Color value)

Create a new ColorProperty with a given color.

Parameters:

value - the color to use.

Method Detail

getInstance

public static ColorProperty getInstance(FOUserAgent foUserAgent,
                                        java.lang.String value)
                                 throws PropertyException

Set the color given a particular String. For a full List of supported values please see ColorUtil.

Parameters:

foUserAgent - FOP user agent

value - RGB value as String to be parsed

Returns:

the canonical ColorProperty instance corresponding to the given value

Throws:

PropertyException - if the value can't be parsed

See Also:

ColorUtil.parseColorString(FOUserAgent, String)

getColor

public java.awt.Color getColor(FOUserAgent foUserAgent)

Returns an AWT instance of this color

Overrides:

getColor in class Property

Parameters:

foUserAgent - FOP user agent

Returns:

float the AWT color represented by this ColorType instance

toString

public java.lang.String toString()

Overrides:

toString in class Property

getColorProperty

public ColorProperty getColorProperty()

Can't convert to any other types

Returns:

this.colorType

getObject

public java.lang.Object getObject()

Description copied from class: Property

This method expects to be overridden by subclasses

Overrides:

getObject in class Property

Returns:

this.colorType cast as an Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object