ColorPropertyType (JHPropertiesTyped

java.lang.Object
- dk.heick.properties.PropertyType<Color>
- - dk.heick.properties.types.ColorPropertyType

All Implemented Interfaces:: Serializable

public class ColorPropertyType
extends PropertyType<Color>

PropertyType that validates to a color value.
This type convert and validates a string to a java.awt.Color.
The string value is trimmed before conversion.

Since version 1.7, it now supports a series of different Color formats. Please see documentation on ColorFormats supported on either :

ColorFormats (local)
ColorFormats (SourceForge)

But here is a short list of the formats with examples:

HexAlphaColorFormat : #337799ff, 0x337799ff, 337799ff
HexColorFormat : #337799, 0x337799, 337799
CMYKColorFormat : cmyk(0.8063,0.3874,0,0.2510)
HSBAColorFormat : hsba(355.2,82.7% ,89.01%,1.0)
HSBColorFormat : hsb(355.2,82.7% ,89.01%)
HSLAColorFormat : hsla(45.2,88.121%,99.112%,0.082)
HSLColorFormat : hsl(45.2,88.121%,99.112%)
HSVAColorFormat : hsva(355.2,82.7% ,89.01%,1.0)
HSVColorFormat : hsv(355.2,82.7% ,89.01%)
RGBAColorFormat : rgba(11,22,33,0.4), rgba(212,0x1A,0x00,1.0), rgba(11%,22%,33%,0.0)
RGBColorFormat : rgb(11,22,33), rgb(212,0x1A,0x00), rgb(11%,22%,33%)
SVGNamedColorFormat : RED, black, Blue
YUVColorFormat : yuv(0.398,0.173,-0.222)

The Color is stored in the property io as a '#RGB' - example '#ffff00'

Constructor Example			Comments
Property<Color> A_PROPERTY = new Property<Color>("name", new ColorPropertyType());			No default value. No min or max color constraints.
Property<Color> A_PROPERTY = new Property<Color>("name", new ColorPropertyType(Color.blue));			Default value is "Color.blue". No min or max color constraints.
Property<Color> A_PROPERTY = new Property<Color>("name", new ColorPropertyType(Color.blue,new Color(33,33,33),new Color(99,99,99)));			Default value is "Color.blue". The color value must be between #333333 and #999999 both inclusive.
Type of value(s)	Examples	Result	Comments
Invalid	cow	`null`	Validate will throw an exception. The resulting value is `null`.
Invalid	horse	`null`
Invalid	«empty string»	`null`
Invalid	«empty string after trim»	`null`
Invalid	`null`	`defaultValue` OR `null`	Validate will throw an exception. Return default value if set, otherwise `null`.

Since:: 1.0
Author:: Frederik Heick
See Also:: Color, Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String TYPE
The type name string constant of ColorPropertyType

Fields
Modifier and Type	Field and Description
`static String`	`TYPE` The type name string constant of ColorPropertyType

Constructor Summary

Constructors
Constructor and Description
`ColorPropertyType()` Returns `ColorPropertyType` where the default value is `null`. Color Formatter is default `RGBAColorFormat()` for colors with alpha value that differs from 255, and `HexColorFormat()` when not
`ColorPropertyType(Color defaultValue)` Returns `ColorPropertyType` with default value.
`ColorPropertyType(Color minColor, Color maxColor)` Returns `ColorPropertyType` with no default value, but with min or max color value. Color Formatter is default `RGBAColorFormat()` for colors with alpha value that differs from 255, and `HexColorFormat()` when not
`ColorPropertyType(Color defaultValue, Color minColor, Color maxColor)` Returns `ColorPropertyType` with default value and min or max color value. Color Formatter is default `RGBAColorFormat()` for colors with alpha value that differs from 255, and `HexColorFormat()` when not

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected ColorComparator`	`getColorComparator()` Gets a new instance of the current ColorComparator.
`List<ColorFormat>`	`getColorFormats()` All known color formats for the PropertyType in a `Collections.unmodifiableList`.
`ColorFormat`	`getFormatterWithAlpha()` Gets the ColorFormat used when making a string representation with alpha value of a color.
`ColorFormat`	`getFormatterWithoutAlpha()` Gets the ColorFormat used when making a string representation without alpha value of a color.
`ColorFormat`	`getLastFormatterUsed()` Gets the last ColorFormat instance used to read and convert a String value into a Color.
`Color`	`getMaxColor()` Gets the maximum color a value is allowed to be.
`Color`	`getMinColor()` Gets the minimum color a value is allowed to be.
`List<String>`	`getRestrictions()` Gets a detailed description of the PropertyType with any constraints that might influence the validation.
`boolean`	`isUseLastFormatter()` Will we be using the last ColorFormat to set Color values.
`boolean`	`isUseMaxColor()` If there is maximum limit on the color value.
`boolean`	`isUseMinColor()` If there is minimum limit on the color value.
`void`	`setFormatterWithAlpha(ColorFormat formatter)` Sets the ColorFormat used when constructing a string version of a color which has an alpha value different from 255.
`void`	`setFormatterWithoutAlpha(ColorFormat formatter)` Sets the ColorFormat used when constructing a string version of a color which has an alpha value equal to 255, meaning that alpha value will not be rendered.
`void`	`setLastFormatterUsed(ColorFormat lastFormatterUsed)` Set the ColorFormat we want to use when converting a Color to String an setting the Color in a PropertyIO.
`void`	`setMaxColor(Color maxColor)` Sets the maximum color a value is allowed to be.
`void`	`setMinColor(Color minColor)` Sets the minimum color a value is allowed to be.
`String`	`toString(String propertyName, Color t)` A string version of the color.
`void`	`validateConstraints(String propertyName)` A PropertyType can have some constraints here is where they are validated.
`Color`	`validateValue(String propertyName, String value)` Converts the string representation of to a typed value.

Methods inherited from class dk.heick.properties.PropertyType
equals, getDefaultValue, getDefaultValueAsString, getDefaultValueDescription, getDescription, getDescription, getInitializationPriority, getIo, getLogger, getTypeName, hasDefaultValue, isDefaultValueValid, postGetValueProcessing, setDefaultValue, setInitializationPriority, setIo, setTypedValue, setTypeName, toType, validate, validateNullType

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE
```
public static final String TYPE
```
    The type name string constant of ColorPropertyType
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ColorPropertyType
```
public ColorPropertyType()
```
    Returns ColorPropertyType where the default value is null.
    Color Formatter is default RGBAColorFormat() for colors with alpha value that differs from 255, and HexColorFormat() when not
  - ColorPropertyType
```
public ColorPropertyType(Color defaultValue)
```
    Returns ColorPropertyType with default value. No min or max Color value.
    Color Formatter is default RGBAColorFormat() for colors with alpha value that differs from 255, and HexColorFormat() when not
    
    Parameters:
    
    defaultValue - default value returned if property value is undefined.
  - ColorPropertyType
```
public ColorPropertyType(Color minColor,
                         Color maxColor)
```
    Returns ColorPropertyType with no default value, but with min or max color value.
    Color Formatter is default RGBAColorFormat() for colors with alpha value that differs from 255, and HexColorFormat() when not
    
    Parameters:
    
    minColor - the min color allowed, if null no min color limit, all RGB values must be less than maxColor RGB values (if not null).
    
    maxColor - the max color allowed, if null no max color limit, all RGB values must be greather than minColor RGB values (if not null).
  - ColorPropertyType
```
public ColorPropertyType(Color defaultValue,
                         Color minColor,
                         Color maxColor)
```
    Returns ColorPropertyType with default value and min or max color value.
    Color Formatter is default RGBAColorFormat() for colors with alpha value that differs from 255, and HexColorFormat() when not
    
    Parameters:
    
    defaultValue - default value returned if property value is undefined.
    
    minColor - the min color allowed, if null no min color limit, all RGB values must be less than maxColor RGB values (if not null).
    
    maxColor - the max color allowed, if null no max color limit, all RGB values must be greather than minColor RGB values (if not null).
- Method Detail
  - getColorFormats
```
public List<ColorFormat> getColorFormats()
```
    All known color formats for the PropertyType in a Collections.unmodifiableList.
    
    Returns:
    
    the colorFormats in an unmodifiableList.
  - getRestrictions
```
public List<String> getRestrictions()
```
    Description copied from class: PropertyType
    
    Gets a detailed description of the PropertyType with any constraints that might influence the validation.
    This includes a description for the default value, if the default do not it self parse the validation of the type, the exception is appended to the description.
    
    Specified by:
    
    getRestrictions in class PropertyType<Color>
    
    Returns:
    
    the restrictions of the PropertyType as a list of strings.
  - toString
```
public String toString(String propertyName,
                       Color t)
                throws PropertyException
```
    A string version of the color.
    If the isUseLastFormatter() is true and the getLastFormatterUsed() is not null, then we use this to convert the Color to a String. Otherwise if the color has a alpha value that differs from 255, the a string is return in the, getFormatterWithAlpha(), otherwise the getFormatterWithoutAlpha() is used. Color Formatter is default RGBAColorFormat() for colors with alpha value that differs from 255, and HexColorFormat() when not.
    Overrides: toString in class PropertyType<Color> Parameters: propertyName - the name of the property used for logging purposes. t - the type T. Returns: The string representation of the type. Throws: PropertyException - if conversion failed in validation. See Also: getFormatterWithAlpha(), getFormatterWithoutAlpha(), isUseLastFormatter(), getLastFormatterUsed()
  validateValue public Color validateValue(String propertyName, String value) throws PropertyException Description copied from class: PropertyType Converts the string representation of to a typed value. Including validation of any restrictions the PropertyType might have. See the individual property type class description for details on how it convert to a typed value. IMPORTANT: This only validates the value not the constraints of the PropertyType, which is at this point assumed to be valid. Specified by: validateValue in class PropertyType<Color> Parameters: propertyName - the name of the property used for logging purposes. To uniquely identify the Property with validation issues. value - the string representation of the property Returns: the typed converted value. Throws: PropertyException - if the conversion failed. validateConstraints public void validateConstraints(String propertyName) throws PropertyException Description copied from class: PropertyType A PropertyType can have some constraints here is where they are validated. The constraints of a PropertyType is always assumed to be valid, but what if they are not. Example: What if you have define the MIN value to be larger than the MAX value. The result will be that no value will ever be validated successfully. This is the method where we validate the constraints of a PropertyType before any value is actually validated. Any many cases this will not be nessecary. This method is call in Property.validate(); Overrides: validateConstraints in class PropertyType<Color> Parameters: propertyName - the name of the property used for logging purposes, to identify the unique property which PropertyType has constraint issues. Throws: PropertyException - if the constraints have invalid/conflicting values. See Also: Property.validate() getMinColor public Color getMinColor() Gets the minimum color a value is allowed to be. Returns: the miminum color, null means no limit. getMaxColor public Color getMaxColor() Gets the maximum color a value is allowed to be. Returns: the color, null means no limit. setMinColor public void setMinColor(Color minColor) Sets the minimum color a value is allowed to be. Parameters: minColor - the minimum color, null means no limit. setMaxColor public void setMaxColor(Color maxColor) Sets the maximum color a value is allowed to be. Parameters: maxColor - the maximum color, null means no limit. isUseMinColor public boolean isUseMinColor() If there is minimum limit on the color value. Returns: true, if getMinColor is different from null meaning there is a minimum limit. Otherwise false. isUseMaxColor public boolean isUseMaxColor() If there is maximum limit on the color value. Returns: true, if getMaxColor is different from null meaning there is a maximum limit. Otherwise false. getFormatterWithAlpha public ColorFormat getFormatterWithAlpha() Gets the ColorFormat used when making a string representation with alpha value of a color. Returns: ColorFormat that supports alpha value. getFormatterWithoutAlpha public ColorFormat getFormatterWithoutAlpha() Gets the ColorFormat used when making a string representation without alpha value of a color. Returns: the ColorFormat setFormatterWithAlpha public void setFormatterWithAlpha(ColorFormat formatter) throws NullPointerException, IllegalArgumentException Sets the ColorFormat used when constructing a string version of a color which has an alpha value different from 255. Parameters: formatter - the ColorFormat used when an alpha value also shall be represented. Throws: NullPointerException - if the formatter is null. IllegalArgumentException - if the formatter do not supports alpha. See Also: ColorFormat.isAlphaSupported() setFormatterWithoutAlpha public void setFormatterWithoutAlpha(ColorFormat formatter) throws NullPointerException Sets the ColorFormat used when constructing a string version of a color which has an alpha value equal to 255, meaning that alpha value will not be rendered. Be aware you can set a formatter which supports and renders the alpha value, even if this is not the intention. Parameters: formatter - formatter the ColorFormat used when an alpha value shall not be represented. Throws: NullPointerException - if the formatter is null. getLastFormatterUsed public ColorFormat getLastFormatterUsed() Gets the last ColorFormat instance used to read and convert a String value into a Color. Returns: the the last ColorFormat used to read. isUseLastFormatter public boolean isUseLastFormatter() Will we be using the last ColorFormat to set Color values. So it will be the same. Returns: the useLastFormatter setLastFormatterUsed public void setLastFormatterUsed(ColorFormat lastFormatterUsed) Set the ColorFormat we want to use when converting a Color to String an setting the Color in a PropertyIO. Parameters: lastFormatterUsed - the lastFormatterUsed to set a the color value. getColorComparator protected ColorComparator getColorComparator() Gets a new instance of the current ColorComparator. Returns: an new instance of ColorExactComparator

Class ColorPropertyType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class dk.heick.properties.PropertyType

Methods inherited from class java.lang.Object

Field Detail

TYPE

Constructor Detail

ColorPropertyType

ColorPropertyType

ColorPropertyType

ColorPropertyType

Method Detail

getColorFormats

getRestrictions

toString

validateValue

validateConstraints

getMinColor

getMaxColor

setMinColor

setMaxColor

isUseMinColor

isUseMaxColor

getFormatterWithAlpha

getFormatterWithoutAlpha

setFormatterWithAlpha

setFormatterWithoutAlpha

getLastFormatterUsed

isUseLastFormatter

setLastFormatterUsed

getColorComparator