org.apache.fop.fo.properties
Class ColorProperty

java.lang.Object
  org.apache.fop.fo.properties.Property
      org.apache.fop.fo.properties.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 java.awt.Color

color The color represented by this property.

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

log

Constructor Summary

ColorProperty(java.awt.Color value)
Create a new ColorProperty with a given color.

ColorProperty(FOUserAgent foUserAgent, java.lang.String value)
Set the color given a particular String.

Method Summary

java.awt.Color	getColor(FOUserAgent foUserAgent) Returns an AWT instance of this color
ColorProperty	getColorProperty() Can't convert to any other types
java.lang.Object	getObject() This method expects to be overridden by subclasses
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

color

protected final java.awt.Color color

The color represented by this property.

Constructor Detail

ColorProperty

public ColorProperty(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

Throws:

PropertyException - if the value can't be parsed

See Also:

ColorUtil#parseColorString(String)

ColorProperty

public ColorProperty(java.awt.Color value)

Create a new ColorProperty with a given color.

Parameters:

value - the color to use.

Method Detail

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

See Also:

Object.toString()

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