Package adams.core.base

Class BaseColor

java.lang.Object

adams.core.base.BaseObject

adams.core.base.BaseColor

All Implemented Interfaces:

CloneHandler<BaseObject>, Serializable, Comparable

public class BaseColor
extends BaseObject

Wrapper for a Color object to be editable in the GOE.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT	the default value.

Fields inherited from class adams.core.base.BaseObject

m_Internal, m_Properties, SUFFIX_DISPLAY, SUFFIX_VALUE

Constructor Summary

Constructors

Constructor	Description
BaseColor()	Initializes the string with length 0.
BaseColor(Color color)	Initializes the object with the color.
BaseColor(String s)	Initializes the object with the hex string to parse.

Method Summary

Modifier and Type	Method	Description
String	getTipText()	Returns a tool tip for the GUI editor (ignored if null is returned).
String	getValue()	Returns the current string value.
protected void	initialize()	Initializes the internal object.
boolean	isValid(String value)	Checks whether the string value is a valid presentation for this class.
void	setValue(String value)	Sets the string value.
Color	toColorValue()	Returns a Color object.

Methods inherited from class adams.core.base.BaseObject

compareTo, equals, getClone, getInternal, getTemplates, getUnicode, hasFavoritesSupport, hashCode, isValidUnicode, newInstance, setUnicode, toObjectArray, toObjectArray, toString, toStringArray, toStringList

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final String DEFAULT

the default value.

See Also:

Constant Field Values

Constructor Detail

BaseColor

public BaseColor()

Initializes the string with length 0.

BaseColor

public BaseColor(String s)

Initializes the object with the hex string to parse.

Parameters:

s - the hex string to parse

BaseColor

public BaseColor(Color color)

Initializes the object with the color.

Parameters:

color - the color to initialize with

Method Detail

initialize

protected void initialize()

Initializes the internal object.

Overrides:

initialize in class BaseObject

isValid

public boolean isValid(String value)

Checks whether the string value is a valid presentation for this class.

Specified by:

isValid in class BaseObject

Parameters:

value - the string value to check

Returns:

true if valid

setValue

public void setValue(String value)

Sets the string value.

Specified by:

setValue in class BaseObject

Parameters:

value - the string value

getValue

public String getValue()

Returns the current string value.

Specified by:

getValue in class BaseObject

Returns:

the string value

toColorValue

public Color toColorValue()

Returns a Color object.

Returns:

the color

getTipText

public String getTipText()

Returns a tool tip for the GUI editor (ignored if null is returned).

Specified by:

getTipText in class BaseObject

Returns:

the tool tip