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

Class LongFormField.LongFormFieldBuilder

java.lang.Object

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

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

com.github.tadukoo.view.form.field.number.LongFormField.LongFormFieldBuilder

Enclosing class:

LongFormField

public static class LongFormField.LongFormFieldBuilder
extends NumberFormField.NumberFormFieldBuilder<Long>

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

LongFormFieldBuilder

private LongFormFieldBuilder()

Can't create outside of LongFormField

Method Details

key

public LongFormField.LongFormFieldBuilder key(String key)

Overrides:

key in class FormField.FormFieldBuilder<Long>

Parameters:

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

Returns:

this, to continue building

defaultValue

public LongFormField.LongFormFieldBuilder defaultValue(Long defaultValue)

Overrides:

defaultValue in class FormField.FormFieldBuilder<Long>

Parameters:

defaultValue - The starting value of the field

Returns:

this, to continue building

labelType

public LongFormField.LongFormFieldBuilder labelType(LabelType labelType)

Overrides:

labelType in class FormField.FormFieldBuilder<Long>

Parameters:

labelType - The LabelType to use for the field

Returns:

this, to continue building

labelForegroundPaint

public LongFormField.LongFormFieldBuilder labelForegroundPaint(SizablePaint labelForegroundPaint)

Overrides:

labelForegroundPaint in class FormField.FormFieldBuilder<Long>

Parameters:

labelForegroundPaint - The SizablePaint for the foreground of the Label

Returns:

this, to continue building

labelBackgroundPaint

public LongFormField.LongFormFieldBuilder labelBackgroundPaint(SizablePaint labelBackgroundPaint)

Overrides:

labelBackgroundPaint in class FormField.FormFieldBuilder<Long>

Parameters:

labelBackgroundPaint - The SizablePaint for the background of the Label

Returns:

this, to continue building

labelFont

public LongFormField.LongFormFieldBuilder labelFont(FontFamily labelFontFamily,
 int labelFontStyle,
 int labelFontSize)

Specifies the font to use on the Label

Overrides:

labelFont in class FormField.FormFieldBuilder<Long>

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 LongFormField.LongFormFieldBuilder labelShape(ShapeInfo labelShape)

Overrides:

labelShape in class FormField.FormFieldBuilder<Long>

Parameters:

labelShape - The ShapeInfo to use for the Label

Returns:

this, to continue building

labelBorder

public LongFormField.LongFormFieldBuilder labelBorder(Border labelBorder)

Overrides:

labelBorder in class FormField.FormFieldBuilder<Long>

Parameters:

labelBorder - The Border to use for the Label

Returns:

this, to continue building

rowPos

public LongFormField.LongFormFieldBuilder rowPos(int rowPos)

Overrides:

rowPos in class FormField.FormFieldBuilder<Long>

Parameters:

rowPos - The row position of the field

Returns:

this, to continue building

colPos

public LongFormField.LongFormFieldBuilder colPos(int colPos)

Overrides:

colPos in class FormField.FormFieldBuilder<Long>

Parameters:

colPos - The column position of the field

Returns:

this, to continue building

rowSpan

public LongFormField.LongFormFieldBuilder rowSpan(int rowSpan)

Overrides:

rowSpan in class FormField.FormFieldBuilder<Long>

Parameters:

rowSpan - The row span of the field

Returns:

this, to continue building

colSpan

public LongFormField.LongFormFieldBuilder colSpan(int colSpan)

Overrides:

colSpan in class FormField.FormFieldBuilder<Long>

Parameters:

colSpan - The column span of the field

Returns:

this, to continue building

logFontResourceLoaderWarnings

public LongFormField.LongFormFieldBuilder logFontResourceLoaderWarnings(boolean logFontResourceLoaderWarnings)

Overrides:

logFontResourceLoaderWarnings in class FormField.FormFieldBuilder<Long>

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

Overrides:

logger in class FormField.FormFieldBuilder<Long>

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 LongFormField.LongFormFieldBuilder graphEnv(GraphicsEnvironment graphEnv)

Overrides:

graphEnv in class FormField.FormFieldBuilder<Long>

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 LongFormField.LongFormFieldBuilder fontFolder(String fontFolder)

Overrides:

fontFolder in class FormField.FormFieldBuilder<Long>

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 LongFormField.LongFormFieldBuilder fontResourceLoader(FontResourceLoader fontResourceLoader)

Overrides:

fontResourceLoader in class FormField.FormFieldBuilder<Long>

Parameters:

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

Returns:

this, to continue building

minValue

public LongFormField.LongFormFieldBuilder minValue(Long minValue)

Overrides:

minValue in class NumberFormField.NumberFormFieldBuilder<Long>

Parameters:

minValue - The minimum value allowed for the field

Returns:

this, to continue building

maxValue

public LongFormField.LongFormFieldBuilder maxValue(Long maxValue)

Overrides:

maxValue in class NumberFormField.NumberFormFieldBuilder<Long>

Parameters:

maxValue - The maximum value allowed for the field

Returns:

this, to continue building

stepSize

public LongFormField.LongFormFieldBuilder stepSize(Long stepSize)

Overrides:

stepSize in class NumberFormField.NumberFormFieldBuilder<Long>

Parameters:

stepSize - The increment value for the spinner for the field

Returns:

this, to continue building

build

public LongFormField build()

Builds the FormField

Specified by:

build in class NumberFormField.NumberFormFieldBuilder<Long>

Returns:

A newly created FormField