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

Class DoubleFormField.DoubleFormFieldBuilder

java.lang.Object

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

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

com.github.tadukoo.view.form.field.number.DoubleFormField.DoubleFormFieldBuilder

Enclosing class:

DoubleFormField

public static class DoubleFormField.DoubleFormFieldBuilder
extends NumberFormField.NumberFormFieldBuilder<Double>

Builder to be used to create an DoubleFormField. 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	DoubleFormFieldBuilder()	Can't create outside of DoubleFormField

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

DoubleFormFieldBuilder

private DoubleFormFieldBuilder()

Can't create outside of DoubleFormField

Method Details

key

public DoubleFormField.DoubleFormFieldBuilder key(String key)

Overrides:

key in class FormField.FormFieldBuilder<Double>

Parameters:

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

Returns:

this, to continue building

defaultValue

public DoubleFormField.DoubleFormFieldBuilder defaultValue(Double defaultValue)

Overrides:

defaultValue in class FormField.FormFieldBuilder<Double>

Parameters:

defaultValue - The starting value of the field

Returns:

this, to continue building

labelType

public DoubleFormField.DoubleFormFieldBuilder labelType(LabelType labelType)

Overrides:

labelType in class FormField.FormFieldBuilder<Double>

Parameters:

labelType - The LabelType to use for the field

Returns:

this, to continue building

labelForegroundPaint

public DoubleFormField.DoubleFormFieldBuilder labelForegroundPaint(SizablePaint labelForegroundPaint)

Overrides:

labelForegroundPaint in class FormField.FormFieldBuilder<Double>

Parameters:

labelForegroundPaint - The SizablePaint for the foreground of the Label

Returns:

this, to continue building

labelBackgroundPaint

public DoubleFormField.DoubleFormFieldBuilder labelBackgroundPaint(SizablePaint labelBackgroundPaint)

Overrides:

labelBackgroundPaint in class FormField.FormFieldBuilder<Double>

Parameters:

labelBackgroundPaint - The SizablePaint for the background of the Label

Returns:

this, to continue building

labelFont

public DoubleFormField.DoubleFormFieldBuilder labelFont(FontFamily labelFontFamily,
 int labelFontStyle,
 int labelFontSize)

Specifies the font to use on the Label

Overrides:

labelFont in class FormField.FormFieldBuilder<Double>

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 DoubleFormField.DoubleFormFieldBuilder labelShape(ShapeInfo labelShape)

Overrides:

labelShape in class FormField.FormFieldBuilder<Double>

Parameters:

labelShape - The ShapeInfo to use for the Label

Returns:

this, to continue building

labelBorder

public DoubleFormField.DoubleFormFieldBuilder labelBorder(Border labelBorder)

Overrides:

labelBorder in class FormField.FormFieldBuilder<Double>

Parameters:

labelBorder - The Border to use for the Label

Returns:

this, to continue building

rowPos

public DoubleFormField.DoubleFormFieldBuilder rowPos(int rowPos)

Overrides:

rowPos in class FormField.FormFieldBuilder<Double>

Parameters:

rowPos - The row position of the field

Returns:

this, to continue building

colPos

public DoubleFormField.DoubleFormFieldBuilder colPos(int colPos)

Overrides:

colPos in class FormField.FormFieldBuilder<Double>

Parameters:

colPos - The column position of the field

Returns:

this, to continue building

rowSpan

public DoubleFormField.DoubleFormFieldBuilder rowSpan(int rowSpan)

Overrides:

rowSpan in class FormField.FormFieldBuilder<Double>

Parameters:

rowSpan - The row span of the field

Returns:

this, to continue building

colSpan

public DoubleFormField.DoubleFormFieldBuilder colSpan(int colSpan)

Overrides:

colSpan in class FormField.FormFieldBuilder<Double>

Parameters:

colSpan - The column span of the field

Returns:

this, to continue building

logFontResourceLoaderWarnings

public DoubleFormField.DoubleFormFieldBuilder logFontResourceLoaderWarnings(boolean logFontResourceLoaderWarnings)

Overrides:

logFontResourceLoaderWarnings in class FormField.FormFieldBuilder<Double>

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

Overrides:

logger in class FormField.FormFieldBuilder<Double>

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 DoubleFormField.DoubleFormFieldBuilder graphEnv(GraphicsEnvironment graphEnv)

Overrides:

graphEnv in class FormField.FormFieldBuilder<Double>

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 DoubleFormField.DoubleFormFieldBuilder fontFolder(String fontFolder)

Overrides:

fontFolder in class FormField.FormFieldBuilder<Double>

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 DoubleFormField.DoubleFormFieldBuilder fontResourceLoader(FontResourceLoader fontResourceLoader)

Overrides:

fontResourceLoader in class FormField.FormFieldBuilder<Double>

Parameters:

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

Returns:

this, to continue building

minValue

public DoubleFormField.DoubleFormFieldBuilder minValue(Double minValue)

Overrides:

minValue in class NumberFormField.NumberFormFieldBuilder<Double>

Parameters:

minValue - The minimum value allowed for the field

Returns:

this, to continue building

maxValue

public DoubleFormField.DoubleFormFieldBuilder maxValue(Double maxValue)

Overrides:

maxValue in class NumberFormField.NumberFormFieldBuilder<Double>

Parameters:

maxValue - The maximum value allowed for the field

Returns:

this, to continue building

stepSize

public DoubleFormField.DoubleFormFieldBuilder stepSize(Double stepSize)

Overrides:

stepSize in class NumberFormField.NumberFormFieldBuilder<Double>

Parameters:

stepSize - The increment value for the spinner for the field

Returns:

this, to continue building

build

public DoubleFormField build()

Builds the FormField

Specified by:

build in class NumberFormField.NumberFormFieldBuilder<Double>

Returns:

A newly created FormField