Package org.graffiti.plugin.parameter

Class ColorParameter

java.lang.Object

org.graffiti.plugin.parameter.AbstractSingleParameter

org.graffiti.plugin.parameter.ColorParameter

All Implemented Interfaces:

Displayable, Parameter, SingleParameter

public class ColorParameter
extends AbstractSingleParameter

Constructor Summary

Constructors

Constructor	Description
ColorParameter(Color value, String name, String description)

Method Summary

Modifier and Type	Method	Description
Color	getColor()
Object	getValue()	Returns the value of this parameter.
boolean	isValid()
void	setValue(Object value)	Sets the encapsulated object.
String	toXMLString()	Returns a well-formed XML string representing the Displayable.

Methods inherited from class org.graffiti.plugin.parameter.AbstractSingleParameter

getDescription, getIcon, getImage, getName, isLeftAligned, setDescription, setLeftAligned, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ColorParameter

public ColorParameter(Color value,
String name,
String description)

Method Details

getColor

public Color getColor()

isValid

public boolean isValid()

setValue

public void setValue(Object value)

Description copied from interface: Displayable

Sets the encapsulated object.

Specified by:

setValue in interface Displayable

Overrides:

setValue in class AbstractSingleParameter

getValue

public Object getValue()

Returns the value of this parameter.

Specified by:

getValue in interface Displayable

Overrides:

getValue in class AbstractSingleParameter

Returns:

the value of this parameter.

toXMLString

public String toXMLString()

Description copied from interface: Displayable

Returns a well-formed XML string representing the Displayable. The Displayable should be reconstructable via this representation. Therefore it must at least include the type of Displayable (classname) and a representation of its value. PROBABLE FUTURE DESIGN: The Displayables themselves will provide a method to reconstruct their value from the XML representation they provided.

Specified by:

toXMLString in interface Displayable

Overrides:

toXMLString in class AbstractSingleParameter

Returns:

string holding an XML representation of this Displayable

See Also:

Displayable.toXMLString()