jidefx.utils.converter.javafx

Class RgbColorConverter

java.lang.Object

javafx.util.StringConverter<T>

jidefx.utils.converter.DefaultObjectConverter<javafx.scene.paint.Color>

jidefx.utils.converter.javafx.RgbColorConverter

All Implemented Interfaces:

ColorConverter, ObjectConverter<javafx.scene.paint.Color>

public class RgbColorConverter
extends DefaultObjectConverter<javafx.scene.paint.Color>
implements 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 interface jidefx.utils.converter.javafx.ColorConverter

CONTEXT_HEX, CONTEXT_HEX_WITH_ALPHA, CONTEXT_RGB, CONTEXT_RGBA, CONTEXT_WEB

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
javafx.scene.paint.Color	fromString(java.lang.String string, ConverterContext context) Return null in most cases unless the generic type T is also a String.
boolean	isOpacityIncluded() Get the flag if this converter should consider alpha value.
void	setOpacityIncluded(boolean opacityIncluded) Set the flag if this converter should consider alpha value.
java.lang.String	toString(javafx.scene.paint.Color color, ConverterContext context) Converts the value to String.

Methods inherited from class jidefx.utils.converter.DefaultObjectConverter

fromString, getObjectConverterManager, toString, toStringConverter

Methods inherited from class java.lang.Object

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

Methods inherited from interface jidefx.utils.converter.ObjectConverter

toStringConverter

Constructor Detail

RgbColorConverter

public RgbColorConverter()

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

RgbColorConverter

public RgbColorConverter(boolean opacityIncluded)

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

Parameters:

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

Method Detail

isOpacityIncluded

public boolean isOpacityIncluded()

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

setOpacityIncluded

public void setOpacityIncluded(boolean opacityIncluded)

Set the flag if this converter should consider alpha value.

Parameters:

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

See Also:

isOpacityIncluded()

toString

public java.lang.String toString(javafx.scene.paint.Color color,
                                 ConverterContext context)

Description copied from class: DefaultObjectConverter

Converts the value to String. If the value is null, "" will be returned. Otherwise it will return value.toString().

Specified by:

toString in interface ObjectConverter<javafx.scene.paint.Color>

Overrides:

toString in class DefaultObjectConverter<javafx.scene.paint.Color>

Parameters:

color - the value to be concerted.

context - converter context to be used

Returns:

a String representation of the value.

fromString

public javafx.scene.paint.Color fromString(java.lang.String string,
                                           ConverterContext context)

Description copied from class: DefaultObjectConverter

Return null in most cases unless the generic type T is also a String.

Specified by:

fromString in interface ObjectConverter<javafx.scene.paint.Color>

Overrides:

fromString in class DefaultObjectConverter<javafx.scene.paint.Color>

Parameters:

string - the string

context - context to be converted

Returns:

null or the string itself.