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

Class FloatFormField.FloatFormFieldBuilder

java.lang.Object

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

com.github.tadukoo.view.form.field.number.NumberFormField.NumberFormFieldBuilder<Float>

com.github.tadukoo.view.form.field.number.FloatFormField.FloatFormFieldBuilder

Enclosing class:

FloatFormField

public static class FloatFormField.FloatFormFieldBuilder
extends NumberFormField.NumberFormFieldBuilder<Float>

Builder to be used to create an FloatFormField. 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 0
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
minValue	The minimum value allowed for the field	Defaults to null (no minimum)
maxValue	The maximum value allowed for the field	Defaults to null (no maximum)
stepSize	The increment value for the spinner for the field	Defaults to 1.0

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 inherited from class com.github.tadukoo.view.form.field.number.NumberFormField.NumberFormFieldBuilder

maxValue, minValue, stepSize

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	FloatFormFieldBuilder()	Can't create outside of FloatFormField

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

FloatFormFieldBuilder

private FloatFormFieldBuilder()

Can't create outside of FloatFormField

Method Details

key

public FloatFormField.FloatFormFieldBuilder key(String key)

Overrides:

key in class FormField.FormFieldBuilder<Float>

Parameters:

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

Returns:

this, to continue building

defaultValue

public FloatFormField.FloatFormFieldBuilder defaultValue(Float defaultValue)

Overrides:

defaultValue in class FormField.FormFieldBuilder<Float>

Parameters:

defaultValue - The starting value of the field

Returns:

this, to continue building

labelType

public FloatFormField.FloatFormFieldBuilder labelType(LabelType labelType)

Overrides:

labelType in class FormField.FormFieldBuilder<Float>

Parameters:

labelType - The LabelType to use for the field

Returns:

this, to continue building

labelForegroundPaint

public FloatFormField.FloatFormFieldBuilder labelForegroundPaint(SizablePaint labelForegroundPaint)

Overrides:

labelForegroundPaint in class FormField.FormFieldBuilder<Float>

Parameters:

labelForegroundPaint - The SizablePaint for the foreground of the Label

Returns:

this, to continue building

labelBackgroundPaint

public FloatFormField.FloatFormFieldBuilder labelBackgroundPaint(SizablePaint labelBackgroundPaint)

Overrides:

labelBackgroundPaint in class FormField.FormFieldBuilder<Float>

Parameters:

labelBackgroundPaint - The SizablePaint for the background of the Label

Returns:

this, to continue building

labelFont

public FloatFormField.FloatFormFieldBuilder labelFont(FontFamily labelFontFamily,
 int labelFontStyle,
 int labelFontSize)

Specifies the font to use on the Label

Overrides:

labelFont in class FormField.FormFieldBuilder<Float>

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 FloatFormField.FloatFormFieldBuilder labelShape(ShapeInfo labelShape)

Overrides:

labelShape in class FormField.FormFieldBuilder<Float>

Parameters:

labelShape - The ShapeInfo to use for the Label

Returns:

this, to continue building

labelBorder

public FloatFormField.FloatFormFieldBuilder labelBorder(Border labelBorder)

Overrides:

labelBorder in class FormField.FormFieldBuilder<Float>

Parameters:

labelBorder - The Border to use for the Label

Returns:

this, to continue building

rowPos

public FloatFormField.FloatFormFieldBuilder rowPos(int rowPos)

Overrides:

rowPos in class FormField.FormFieldBuilder<Float>

Parameters:

rowPos - The row position of the field

Returns:

this, to continue building

colPos

public FloatFormField.FloatFormFieldBuilder colPos(int colPos)

Overrides:

colPos in class FormField.FormFieldBuilder<Float>

Parameters:

colPos - The column position of the field

Returns:

this, to continue building

rowSpan

public FloatFormField.FloatFormFieldBuilder rowSpan(int rowSpan)

Overrides:

rowSpan in class FormField.FormFieldBuilder<Float>

Parameters:

rowSpan - The row span of the field

Returns:

this, to continue building

colSpan

public FloatFormField.FloatFormFieldBuilder colSpan(int colSpan)

Overrides:

colSpan in class FormField.FormFieldBuilder<Float>

Parameters:

colSpan - The column span of the field

Returns:

this, to continue building

logFontResourceLoaderWarnings

public FloatFormField.FloatFormFieldBuilder logFontResourceLoaderWarnings(boolean logFontResourceLoaderWarnings)

Overrides:

logFontResourceLoaderWarnings in class FormField.FormFieldBuilder<Float>

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 FloatFormField.FloatFormFieldBuilder logger(com.github.tadukoo.util.logger.EasyLogger logger)

Overrides:

logger in class FormField.FormFieldBuilder<Float>

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 FloatFormField.FloatFormFieldBuilder graphEnv(GraphicsEnvironment graphEnv)

Overrides:

graphEnv in class FormField.FormFieldBuilder<Float>

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 FloatFormField.FloatFormFieldBuilder fontFolder(String fontFolder)

Overrides:

fontFolder in class FormField.FormFieldBuilder<Float>

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 FloatFormField.FloatFormFieldBuilder fontResourceLoader(FontResourceLoader fontResourceLoader)

Overrides:

fontResourceLoader in class FormField.FormFieldBuilder<Float>

Parameters:

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

Returns:

this, to continue building

minValue

public FloatFormField.FloatFormFieldBuilder minValue(Float minValue)

Overrides:

minValue in class NumberFormField.NumberFormFieldBuilder<Float>

Parameters:

minValue - The minimum value allowed for the field

Returns:

this, to continue building

maxValue

public FloatFormField.FloatFormFieldBuilder maxValue(Float maxValue)

Overrides:

maxValue in class NumberFormField.NumberFormFieldBuilder<Float>

Parameters:

maxValue - The maximum value allowed for the field

Returns:

this, to continue building

stepSize

public FloatFormField.FloatFormFieldBuilder stepSize(Float stepSize)

Overrides:

stepSize in class NumberFormField.NumberFormFieldBuilder<Float>

Parameters:

stepSize - The increment value for the spinner for the field

Returns:

this, to continue building

build

public FloatFormField build()

Builds the FormField

Specified by:

build in class NumberFormField.NumberFormFieldBuilder<Float>

Returns:

A newly created FormField