Overview Package Class Use Tree Index Deprecated About
fop 0.94
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.fop.fo.properties

Class ColorProperty

public class ColorProperty
extends Property
Superclass for properties that wrap Color values

Nested Class Summary

static class
ColorProperty.Maker
Inner class for creating instances of ColorTypeProperty

Field Summary

protected Color
color
The color represented by this property.

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

log

Constructor Summary

ColorProperty(Color value)
Create a new ColorProperty with a given color.
ColorProperty(FOUserAgent foUserAgent, String value)
Set the color given a particular String.

Method Summary

Color
getColor(FOUserAgent foUserAgent)
Returns an AWT instance of this color
ColorProperty
getColorProperty()
Can't convert to any other types
Object
getObject()
String
toString()

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

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

Field Details

color

protected final Color color
The color represented by this property.

Constructor Details

ColorProperty

public ColorProperty(Color value)
Create a new ColorProperty with a given color.
Parameters:
value - the color to use.

ColorProperty

public ColorProperty(FOUserAgent foUserAgent,
                     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
Throws:
PropertyException - if the value can't be parsed
See Also:
ColorUtil.parseColorString(String)

Method Details

getColor

public Color getColor(FOUserAgent foUserAgent)
Returns an AWT instance of this color
Overrides:
getColor in interface Property
Parameters:
foUserAgent - FOP user agent
Returns:
float the AWT color represented by this ColorType instance

getColorProperty

public ColorProperty getColorProperty()
Can't convert to any other types
Returns:
this.colorType

getObject

public Object getObject()
Overrides:
getObject in interface Property
Returns:
this.colorType cast as an Object

toString

public String toString()
Overrides:
toString in interface Property
See Also:
java.lang.Object.toString()

Overview Package Class Use Tree Index Deprecated About
fop 0.94
Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.