com.jidesoft.converter

Class RgbColorConverter

java.lang.Object

com.jidesoft.converter.ColorConverter

com.jidesoft.converter.RgbColorConverter

All Implemented Interfaces:

ObjectConverter

public class RgbColorConverter
extends ColorConverter

If alpha value is not included, converts Color to/from "XXX, XXX, XXX" format. For example "0, 0, 0" is Color(0, 0, 0) and "255, 0, 255" is Color(255, 0, 255).

If alpha value is included, converts Color to/from "XXX, XXX, XXX, XXX" format. For example "0, 0, 0, 255" is Color(0, 0, 0, 255) and "255, 0, 255, 100" is Color(255, 0, 255, 100).

Field Summary

Fields inherited from class com.jidesoft.converter.ColorConverter

CONTEXT_HEX, CONTEXT_HEX_WITH_ALPHA, CONTEXT_RGB, CONTEXT_RGBA

Constructor Summary

Constructors

Constructor and Description
RgbColorConverter() Creates a RgbColorConverter.
RgbColorConverter(boolean alphaIncluded) Creates a RgbColorConverter.

Method Summary

Methods

Modifier and Type	Method and Description
Object	fromString(String string, ConverterContext context) Converts from String to an object.
boolean	isAlphaIncluded() Get the flag if this converter should consider alpha value.
void	setAlphaIncluded(boolean alphaIncluded) Set the flag if this converter should consider alpha value.
boolean	supportFromString(String string, ConverterContext context) If it supports fromString.
boolean	supportToString(Object object, ConverterContext context) If it supports toString method.
String	toString(Object object, ConverterContext context) Converts from object to String based on current locale.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RgbColorConverter

public RgbColorConverter()

Creates a RgbColorConverter. This is the default constructor and will not include alpha value.

RgbColorConverter

public RgbColorConverter(boolean alphaIncluded)

Creates a RgbColorConverter. With this constructor, you can create a converter with alpha value included.

Parameters:

alphaIncluded - the flag if alpha value will be included in this converter

Method Detail

isAlphaIncluded

public boolean isAlphaIncluded()

Get the flag if this converter should consider alpha value.

If you use default constructor, the default value of this flag is false.

Returns:

true if this converter should consider alpha value.

See Also:

RgbColorConverter

setAlphaIncluded

public void setAlphaIncluded(boolean alphaIncluded)

Set the flag if this converter should consider alpha value.

Parameters:

alphaIncluded - the flag if this converter should consider alpha value.

See Also:

isAlphaIncluded()

toString

public String toString(Object object,
              ConverterContext context)

Description copied from interface: ObjectConverter

Converts from object to String based on current locale.

Parameters:

object - object to be converted

context - converter context to be used

Returns:

the String

supportToString

public boolean supportToString(Object object,
                      ConverterContext context)

Description copied from interface: ObjectConverter

If it supports toString method.

Parameters:

object - object to be converted

context - converter context to be used

Returns:

true if supports toString

supportFromString

public boolean supportFromString(String string,
                        ConverterContext context)

Description copied from interface: ObjectConverter

If it supports fromString.

Parameters:

string - the string

context - context to be converted

Returns:

true if it supports

fromString

public Object fromString(String string,
                ConverterContext context)

Description copied from interface: ObjectConverter

Converts from String to an object.

Parameters:

string - the string

context - context to be converted

Returns:

the object converted from string