com.hfg.graphics

Class ColorSpec

java.lang.Object

com.hfg.graphics.ColorSpec

All Implemented Interfaces:

Cloneable, Comparable<ColorSpec>

public class ColorSpec
extends Object
implements Cloneable, Comparable<ColorSpec>

Encapsulates foreground and background color specifications. The default foreground color is BLACK and no default background color is defined.

Constructor Summary

Constructors

Constructor and Description
ColorSpec()
ColorSpec(XMLTag inXMLTag)

Method Summary

Modifier and Type	Method and Description
ColorSpec	clone()
int	compareTo(ColorSpec inObj2)
boolean	equals(Object inObj2)
Color	getBackgroundColor()
Color	getForegroundColor()
int	hashCode()
ColorSpec	setBackgroundColor(Color inValue) Sets the background color; null values are allowed.
ColorSpec	setForegroundColor(Color inValue) Sets the foreground color; null values are allowed.
String	toString()
XMLTag	toXMLTag()

Methods inherited from class java.lang.Object

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

Constructor Detail

ColorSpec

public ColorSpec()

ColorSpec

public ColorSpec(XMLTag inXMLTag)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

clone

public ColorSpec clone()

Overrides:

clone in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object inObj2)

Overrides:

equals in class Object

compareTo

public int compareTo(ColorSpec inObj2)

Specified by:

compareTo in interface Comparable<ColorSpec>

setForegroundColor

public ColorSpec setForegroundColor(Color inValue)

Sets the foreground color; null values are allowed.

Parameters:

inValue - the color to use for the foreground

Returns:

this ColorSpec object to enable method chaining

getForegroundColor

public Color getForegroundColor()

setBackgroundColor

public ColorSpec setBackgroundColor(Color inValue)

Sets the background color; null values are allowed.

Parameters:

inValue - the color to use for the background

Returns:

this ColorSpec object to enable method chaining

getBackgroundColor

public Color getBackgroundColor()

toXMLTag

public XMLTag toXMLTag()