Package com.github.tadukoo.view.form.field

Class DateFormField.DateFormFieldBuilder

java.lang.Object

com.github.tadukoo.view.form.field.FormField.FormFieldBuilder<Date>

com.github.tadukoo.view.form.field.DateFormField.DateFormFieldBuilder

Enclosing class:

DateFormField

public static class DateFormField.DateFormFieldBuilder
extends FormField.FormFieldBuilder<Date>

Builder to be used to create a DateFormField. It has the following parameters:

FormField Parameters

Name	Description	Default Value or Required
key	The name of the field (used as a key in Forms)	Required
defaultValue	The starting value of the field	Defaults to null
labelType	The LabelType to use for the field	Defaults to LabelType.LABEL
labelForegroundPaint	The SizablePaint for the foreground of the Label	Defaults to null (to use the Look & Feel's default Label foreground paint)
labelBackgroundPaint	The SizablePaint for the background of the Label	Defaults to null (to use the Look & Feel's default Label background paint)
labelFont	The Font to use for the Label - specified as a FontFamily, style, and size	Defaults to null (to use the Look & Feel's default Label font)
labelShape	The ShapeInfo to use for the Label	Defaults to null (to use the Look & Feel's default Label shape)
labelBorder	The Border to use for the Label	Defaults to null (to use the Look & Feel's default Label border)
rowPos	The row position of the field	Required
colPos	The column position of the field	Required
rowSpan	The row span of the field	Defaults to 1
colSpan	The column span of the field	Defaults to 1
minYear	The minimum year to allow on the field	Defaults to 1900
maxYear	The maximum year to allow on the field	Defaults to 2100

This builder also provides methods and parameters for font resource loading:

Font Resource Loading Parameters

Field	Description	Default Value
logFontResourceLoaderWarnings	Whether to log warnings generated by the FontResourceLoader - can be ignored if you specify your own FontResourceLoader	false
logger	An EasyLogger that will be sent to the FontResourceLoader by default - can be ignored if you specify your own FontResourceLoader	null (since logging warnings is set to false by default)
graphEnv	The GraphicsEnvironment to load fonts to in the FontResourceLoader - can be ignored if you specify your own FontResourceLoader	GraphicsEnvironment.getLocalGraphicsEnvironment()
fontFolder	The path to the fonts folder to find font files in if needed in the FontResourceLoader - can be ignored if you specify your own FontResourceLoader	"fonts/"
fontResourceLoader	The FontResourceLoader to use in loading fonts and/or ensuring they're in the system	a new FontResourceLoader with the specified values for logFontResourceLoaderWarnings(boolean), logger(com.github.tadukoo.util.logger.EasyLogger), graphEnv(java.awt.GraphicsEnvironment), and fontFolder(java.lang.String)

Since:

Alpha v.0.2.1

Version:

Alpha v.0.3

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields

Modifier and Type	Field	Description
private int	maxYear	The maximum year to allow on the field
private int	minYear	The minimum year to allow on the field

Fields inherited from class com.github.tadukoo.view.form.field.FormField.FormFieldBuilder

colPos, colSpan, defaultValue, fontFolder, fontResourceLoader, graphEnv, key, labelBackgroundPaint, labelBorder, labelFontFamily, labelFontSize, labelFontStyle, labelForegroundPaint, labelShape, labelType, logFontResourceLoaderWarnings, logger, rowPos, rowSpan

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DateFormFieldBuilder()	Not allowed to create outside of DateFormField

Method Summary

Modifier and Type	Method	Description
DateFormField	build()	Builds the FormField
DateFormField.DateFormFieldBuilder	colPos(int colPos)
DateFormField.DateFormFieldBuilder	colSpan(int colSpan)
DateFormField.DateFormFieldBuilder	defaultValue(Date defaultValue)
DateFormField.DateFormFieldBuilder	fontFolder(String fontFolder)
DateFormField.DateFormFieldBuilder	fontResourceLoader(FontResourceLoader fontResourceLoader)
DateFormField.DateFormFieldBuilder	graphEnv(GraphicsEnvironment graphEnv)
DateFormField.DateFormFieldBuilder	key(String key)
DateFormField.DateFormFieldBuilder	labelBackgroundPaint(SizablePaint labelBackgroundPaint)
DateFormField.DateFormFieldBuilder	labelBorder(Border labelBorder)
DateFormField.DateFormFieldBuilder	labelFont(FontFamily labelFontFamily, int labelFontStyle, int labelFontSize)	Specifies the font to use on the Label
DateFormField.DateFormFieldBuilder	labelForegroundPaint(SizablePaint labelForegroundPaint)
DateFormField.DateFormFieldBuilder	labelShape(ShapeInfo labelShape)
DateFormField.DateFormFieldBuilder	labelType(LabelType labelType)
DateFormField.DateFormFieldBuilder	logFontResourceLoaderWarnings(boolean logFontResourceLoaderWarnings)
DateFormField.DateFormFieldBuilder	logger(com.github.tadukoo.util.logger.EasyLogger logger)
DateFormField.DateFormFieldBuilder	maxYear(int maxYear)
DateFormField.DateFormFieldBuilder	minYear(int minYear)
DateFormField.DateFormFieldBuilder	rowPos(int rowPos)
DateFormField.DateFormFieldBuilder	rowSpan(int rowSpan)

Methods inherited from class java.lang.Object

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

Field Details

minYear

private int minYear

The minimum year to allow on the field

maxYear

private int maxYear

The maximum year to allow on the field

Constructor Details

DateFormFieldBuilder

private DateFormFieldBuilder()

Not allowed to create outside of DateFormField

Method Details

key

public DateFormField.DateFormFieldBuilder key(String key)

Overrides:

key in class FormField.FormFieldBuilder<Date>

Parameters:

key - The name of the field (used as a key in Forms)

Returns:

this, to continue building

defaultValue

public DateFormField.DateFormFieldBuilder defaultValue(Date defaultValue)

Overrides:

defaultValue in class FormField.FormFieldBuilder<Date>

Parameters:

defaultValue - The starting value of the field

Returns:

this, to continue building

labelType

public DateFormField.DateFormFieldBuilder labelType(LabelType labelType)

Overrides:

labelType in class FormField.FormFieldBuilder<Date>

Parameters:

labelType - The LabelType to use for the field

Returns:

this, to continue building

labelForegroundPaint

public DateFormField.DateFormFieldBuilder labelForegroundPaint(SizablePaint labelForegroundPaint)

Overrides:

labelForegroundPaint in class FormField.FormFieldBuilder<Date>

Parameters:

labelForegroundPaint - The SizablePaint for the foreground of the Label

Returns:

this, to continue building

labelBackgroundPaint

public DateFormField.DateFormFieldBuilder labelBackgroundPaint(SizablePaint labelBackgroundPaint)

Overrides:

labelBackgroundPaint in class FormField.FormFieldBuilder<Date>

Parameters:

labelBackgroundPaint - The SizablePaint for the background of the Label

Returns:

this, to continue building

labelFont

public DateFormField.DateFormFieldBuilder labelFont(FontFamily labelFontFamily,
 int labelFontStyle,
 int labelFontSize)

Specifies the font to use on the Label

Overrides:

labelFont in class FormField.FormFieldBuilder<Date>

Parameters:

labelFontFamily - The FontFamily for the Label's font

labelFontStyle - The font style for the Label

labelFontSize - The font size for the Label

Returns:

this, to continue building

labelShape

public DateFormField.DateFormFieldBuilder labelShape(ShapeInfo labelShape)

Overrides:

labelShape in class FormField.FormFieldBuilder<Date>

Parameters:

labelShape - The ShapeInfo to use for the Label

Returns:

this, to continue building

labelBorder

public DateFormField.DateFormFieldBuilder labelBorder(Border labelBorder)

Overrides:

labelBorder in class FormField.FormFieldBuilder<Date>

Parameters:

labelBorder - The Border to use for the Label

Returns:

this, to continue building

rowPos

public DateFormField.DateFormFieldBuilder rowPos(int rowPos)

Overrides:

rowPos in class FormField.FormFieldBuilder<Date>

Parameters:

rowPos - The row position of the field

Returns:

this, to continue building

colPos

public DateFormField.DateFormFieldBuilder colPos(int colPos)

Overrides:

colPos in class FormField.FormFieldBuilder<Date>

Parameters:

colPos - The column position of the field

Returns:

this, to continue building

rowSpan

public DateFormField.DateFormFieldBuilder rowSpan(int rowSpan)

Overrides:

rowSpan in class FormField.FormFieldBuilder<Date>

Parameters:

rowSpan - The row span of the field

Returns:

this, to continue building

colSpan

public DateFormField.DateFormFieldBuilder colSpan(int colSpan)

Overrides:

colSpan in class FormField.FormFieldBuilder<Date>

Parameters:

colSpan - The column span of the field

Returns:

this, to continue building

logFontResourceLoaderWarnings

public DateFormField.DateFormFieldBuilder logFontResourceLoaderWarnings(boolean logFontResourceLoaderWarnings)

Overrides:

logFontResourceLoaderWarnings in class FormField.FormFieldBuilder<Date>

Parameters:

logFontResourceLoaderWarnings - Whether to log warnings generated by the FontResourceLoader - can be ignored if you specify your own FontResourceLoader

Returns:

this, to continue building

logger

public DateFormField.DateFormFieldBuilder logger(com.github.tadukoo.util.logger.EasyLogger logger)

Overrides:

logger in class FormField.FormFieldBuilder<Date>

Parameters:

logger - An EasyLogger that will be sent to the FontResourceLoader by default - can be ignored if you specify your own FontResourceLoader

Returns:

this, to continue building

graphEnv

public DateFormField.DateFormFieldBuilder graphEnv(GraphicsEnvironment graphEnv)

Overrides:

graphEnv in class FormField.FormFieldBuilder<Date>

Parameters:

graphEnv - The GraphicsEnvironment to load fonts to in the FontResourceLoader - can be ignored if you specify your own FontResourceLoader

Returns:

this, to continue building

fontFolder

public DateFormField.DateFormFieldBuilder fontFolder(String fontFolder)

Overrides:

fontFolder in class FormField.FormFieldBuilder<Date>

Parameters:

fontFolder - The path to the fonts folder to find font files in if needed in the FontResourceLoader - can be ignored if you specify your own FontResourceLoader

Returns:

this, to continue building

fontResourceLoader

public DateFormField.DateFormFieldBuilder fontResourceLoader(FontResourceLoader fontResourceLoader)

Overrides:

fontResourceLoader in class FormField.FormFieldBuilder<Date>

Parameters:

fontResourceLoader - The FontResourceLoader to use in loading fonts and/or ensuring they're in the system

Returns:

this, to continue building

minYear

public DateFormField.DateFormFieldBuilder minYear(int minYear)

Parameters:

minYear - The minimum year to allow on the field

Returns:

this, to continue building

maxYear

public DateFormField.DateFormFieldBuilder maxYear(int maxYear)

Parameters:

maxYear - The maximum year to allow on the field

Returns:

this, to continue building

build

public DateFormField build()

Builds the FormField

Specified by:

build in class FormField.FormFieldBuilder<Date>

Returns:

A newly created FormField