griffon.pivot.formatters

Class ColorFormatter

java.lang.Object

griffon.core.formatters.AbstractFormatter<Color>

griffon.pivot.formatters.ColorFormatter

All Implemented Interfaces:

Formatter<Color>

public class ColorFormatter
extends AbstractFormatter<Color>

A Formatter that can parse Strings into java.awt.Color and back using several patterns

Supported patterns are:

• #RGB
• #RGBA
• #RRGGBB
• #RRGGBBAA

Where each letter stands for a particular color components in hexadecimal

• R - red
• G - green
• B - blue
• A - alpha

Since:

2.0.0

Author:

Andres Almiray

See Also:

Formatter

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PATTERN "#RRGGBB"
static ColorFormatter	LONG ColorFormatter that uses the PATTERN_LONG pattern
static ColorFormatter	LONG_WITH_ALPHA ColorFormatter that uses the PATTERN_LONG_WITH_ALPHA pattern
static String	PATTERN_LONG "#RRGGBB"
static String	PATTERN_LONG_WITH_ALPHA "#RRGGBBAA"
static String	PATTERN_SHORT "#RGB"
static String	PATTERN_SHORT_WITH_ALPHA "#RGBA"
static ColorFormatter	SHORT ColorFormatter that uses the PATTERN_SHORT pattern
static ColorFormatter	SHORT_WITH_ALPHA ColorFormatter that uses the PATTERN_SHORT_WITH_ALPHA pattern

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ColorFormatter(String pattern)

Method Summary

Methods

Modifier and Type	Method and Description
String	format(Color color) Formats an instance into its literal representation.
static ColorFormatter	getInstance(String pattern) Returns a ColorFormatter given a color pattern.
String	getPattern() Returns the pattern used by this ColorFormatter
Color	parse(String str) Parses a literal representation into an instance of type T.
static Color	parseColor(String str) Parses a string into a java.awt.Color instance.

Methods inherited from class griffon.core.formatters.AbstractFormatter

parseError, parseError, parseHexInt, parseHexInt

Methods inherited from class java.lang.Object

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

Field Detail

PATTERN_SHORT

public static final String PATTERN_SHORT

"#RGB"

See Also:

Constant Field Values

PATTERN_SHORT_WITH_ALPHA

public static final String PATTERN_SHORT_WITH_ALPHA

"#RGBA"

See Also:

Constant Field Values

PATTERN_LONG

public static final String PATTERN_LONG

"#RRGGBB"

See Also:

Constant Field Values

PATTERN_LONG_WITH_ALPHA

public static final String PATTERN_LONG_WITH_ALPHA

"#RRGGBBAA"

See Also:

Constant Field Values

DEFAULT_PATTERN

public static final String DEFAULT_PATTERN

"#RRGGBB"

See Also:

Constant Field Values

SHORT

public static final ColorFormatter SHORT

ColorFormatter that uses the PATTERN_SHORT pattern

SHORT_WITH_ALPHA

public static final ColorFormatter SHORT_WITH_ALPHA

ColorFormatter that uses the PATTERN_SHORT_WITH_ALPHA pattern

LONG

public static final ColorFormatter LONG

ColorFormatter that uses the PATTERN_LONG pattern

LONG_WITH_ALPHA

public static final ColorFormatter LONG_WITH_ALPHA

ColorFormatter that uses the PATTERN_LONG_WITH_ALPHA pattern

Constructor Detail

ColorFormatter

protected ColorFormatter(@Nullable
              String pattern)

Method Detail

getInstance

@Nonnull
public static ColorFormatter getInstance(@Nullable
                                 String pattern)

Returns a ColorFormatter given a color pattern.

Parameters:

pattern - the input pattern. Must be one of the 4 supported color patterns.

Returns:

a ColorPattern instance

Throws:

IllegalArgumentException - if the supplied pattern is not supported

format

@Nullable
public String format(@Nullable
                     Color color)

Description copied from interface: Formatter

Formats an instance into its literal representation.

The resulting String may be set as an argument to Formatter.parse(java.lang.String) resulting in a similar instance as the input.

Parameters:

color - the instance to be formatted

Returns:

A String representing the instance's state.

parse

@Nullable
public Color parse(@Nullable
                   String str)
            throws ParseException

Description copied from interface: Formatter

Parses a literal representation into an instance of type T.

The resulting instance T may be set as an argument to Formatter.format(T) resulting in an equal String as the input.

Parameters:

str - the String to be parsed

Returns:

an instance of type T whose state is initialized given the parameters of the input String.

Throws:

ParseException - if the String cannot be parsed.

getPattern

@Nonnull
public String getPattern()

Returns the pattern used by this ColorFormatter

Returns:

the pattern this ColorFormatter uses for parsing/formatting.

parseColor

@Nonnull
public static Color parseColor(@Nonnull
                       String str)
                        throws ParseException

Parses a string into a java.awt.Color instance.

The parsing pattern is chosen given the length of the input string

• 4 - #RGB
• 5 - #RGBA
• 7 - #RRGGBB
• 9 - #RRGGBBAA

The input string may also be any of the Color constants identified by griffon.pivot.support.Colors.

Parameters:

str - the string representation of a java.awt.Color

Returns:

a java.awt.Color instance matching the supplied RGBA color components

Throws:

ParseException - if the string cannot be parsed by the chosen pattern

See Also:

Colors