dk.heick.properties.types

Class FontPropertyType

java.lang.Object

dk.heick.properties.PropertyType<Font>

dk.heick.properties.types.FontPropertyType

All Implemented Interfaces:

Serializable

public class FontPropertyType
extends PropertyType<Font>

PropertyType that validates to a Font value. Using the Font.decode(str) method.
The string value is trimmed before conversion.
IMPORTANT:

• Font names is case sensitive.
• Style is not casesensitive.
• Validates that the font name exists in the array "GraphicsEnvironment.getLocalGraphicsEnvironment().getAvailableFontFamilyNames()".
• If Style paramenter is not supplied PLAIN is used.
• If Size paramenter is not supplied 12 is used.

Format [Font.decode(....)]:

• fontname-style-pointsize
• fontname-pointsize
• fontname-style
• fontname
• fontname style pointsize
• fontname pointsize
• fontname style
• fontname

Style (names, case insensitive):

• plain
• bold
• italic
• bolditalic

Note : Be aware that decoding font means access to the OS grahics environment this can be a little time consuming.

Constructor Example			Comments
Property<Font> A_PROPERTY = new Property<Font>("name", new FontPropertyType());			Default value is null.
Property<Font> A_PROPERTY = new Property<Font>("name", new FontPropertyType(new Font("Verdana",Font.BOLD,16));			Default value is new Font("Verdana",Font.BOLD,16).
Type of value(s)	Examples	Result	Comments
Valid	Verdana-BOLD-16	A string validated as a Font("Verdana",Font.BOLD,16).	Validate successfully.
Valid	Verdana italic 18	A string validated as a Font("Verdana",Font.ITALIC,18).	Validate successfully.
Valid	Times New Roman	A string validated as a Font("Times New Roman",Font.PLAIN,12).	Validate successfully.
Invalid	-plain-16	null	Validate will throw an exception. Return default value if set, otherwise null.
Invalid	«empty string»	null
Invalid	«empty string after trim»	null
Invalid	IDontKnowThisFont-italicbold-15	null
InvValid	IDontKnowThisFont	null
Invalid	null	defaultValue OR null	Validate will throw an exception. Return default value if set, otherwise null.

Since:

1.6

Author:

Frederik Heick

See Also:

Font, Font.decode(String), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE The type name string constant of FontPropertyType

Constructor Summary

Constructors

Constructor and Description
FontPropertyType() Constructor, sets the default value to null.
FontPropertyType(Font defaultValue) Constructor.

Method Summary

Modifier and Type	Method and Description
String[]	getAvailableFontFamilyNames() Gets all the available font names from local graphics environment.
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
String	toString(String propertyName, Font t) Converts a typed to the string representation.
Font	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, validateConstraints, 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 FontPropertyType

See Also:

Constant Field Values

Constructor Detail

FontPropertyType

public FontPropertyType()

Constructor, sets the default value to null.

FontPropertyType

public FontPropertyType(Font defaultValue)

Constructor. Sets the default value.

Parameters:

defaultValue - default value returned if property value is undefined.

Method Detail

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<Font>

Returns:

the restrictions of the PropertyType as a list of strings.

validateValue

public Font 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<Font>

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.

toString

public String toString(String propertyName,
                       Font t)
                throws PropertyException

Description copied from class: PropertyType

Converts a typed to the string representation. This must be associative, so the string generate here will successful validate. This is enforced, so the converted string is sub sequencetially validate with the validate method. In some of the property sub types, this method is overridden to ensure above rule.

Overrides:

toString in class PropertyType<Font>

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:

PropertyType.validate(String, String)

getAvailableFontFamilyNames

public String[] getAvailableFontFamilyNames()

Gets all the available font names from local graphics environment.

Returns:

an array of available font names in the OS.

See Also:

GraphicsEnvironment.getLocalGraphicsEnvironment(), GraphicsEnvironment.getAvailableFontFamilyNames()