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

Class TableFormField.TableFormFieldBuilder

java.lang.Object

com.github.tadukoo.view.form.field.FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

com.github.tadukoo.view.form.field.TableFormField.TableFormFieldBuilder

Enclosing class:

TableFormField

public static class TableFormField.TableFormFieldBuilder
extends FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

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

TableFormField 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.NONE
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

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

Version:

Alpha v.0.3

Author:

Logan Ferree (Tadukoo)

Field Summary

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	TableFormFieldBuilder()	Not allowed to create a TableFormFieldBuilder outside of TableFormField

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

TableFormFieldBuilder

private TableFormFieldBuilder()

Not allowed to create a TableFormFieldBuilder outside of TableFormField

Method Details

key

public TableFormField.TableFormFieldBuilder key(String key)

Overrides:

key in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

Parameters:

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

Returns:

this, to continue building

defaultValue

public TableFormField.TableFormFieldBuilder defaultValue(List<com.github.tadukoo.util.pojo.OrderedMappedPojo> defaultValue)

Overrides:

defaultValue in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

Parameters:

defaultValue - The starting value of the field

Returns:

this, to continue building

labelType

public TableFormField.TableFormFieldBuilder labelType(LabelType labelType)

Overrides:

labelType in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

Parameters:

labelType - The LabelType to use for the field

Returns:

this, to continue building

labelForegroundPaint

public TableFormField.TableFormFieldBuilder labelForegroundPaint(SizablePaint labelForegroundPaint)

Overrides:

labelForegroundPaint in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

Parameters:

labelForegroundPaint - The SizablePaint for the foreground of the Label

Returns:

this, to continue building

labelBackgroundPaint

public TableFormField.TableFormFieldBuilder labelBackgroundPaint(SizablePaint labelBackgroundPaint)

Overrides:

labelBackgroundPaint in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

Parameters:

labelBackgroundPaint - The SizablePaint for the background of the Label

Returns:

this, to continue building

labelFont

public TableFormField.TableFormFieldBuilder labelFont(FontFamily labelFontFamily,
 int labelFontStyle,
 int labelFontSize)

Specifies the font to use on the Label

Overrides:

labelFont in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

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 TableFormField.TableFormFieldBuilder labelShape(ShapeInfo labelShape)

Overrides:

labelShape in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

Parameters:

labelShape - The ShapeInfo to use for the Label

Returns:

this, to continue building

labelBorder

public TableFormField.TableFormFieldBuilder labelBorder(Border labelBorder)

Overrides:

labelBorder in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

Parameters:

labelBorder - The Border to use for the Label

Returns:

this, to continue building

rowPos

public TableFormField.TableFormFieldBuilder rowPos(int rowPos)

Overrides:

rowPos in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

Parameters:

rowPos - The row position of the field

Returns:

this, to continue building

colPos

public TableFormField.TableFormFieldBuilder colPos(int colPos)

Overrides:

colPos in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

Parameters:

colPos - The column position of the field

Returns:

this, to continue building

rowSpan

public TableFormField.TableFormFieldBuilder rowSpan(int rowSpan)

Overrides:

rowSpan in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

Parameters:

rowSpan - The row span of the field

Returns:

this, to continue building

colSpan

public TableFormField.TableFormFieldBuilder colSpan(int colSpan)

Overrides:

colSpan in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

Parameters:

colSpan - The column span of the field

Returns:

this, to continue building

logFontResourceLoaderWarnings

public TableFormField.TableFormFieldBuilder logFontResourceLoaderWarnings(boolean logFontResourceLoaderWarnings)

Overrides:

logFontResourceLoaderWarnings in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

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

Overrides:

logger in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

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 TableFormField.TableFormFieldBuilder graphEnv(GraphicsEnvironment graphEnv)

Overrides:

graphEnv in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

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 TableFormField.TableFormFieldBuilder fontFolder(String fontFolder)

Overrides:

fontFolder in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

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 TableFormField.TableFormFieldBuilder fontResourceLoader(FontResourceLoader fontResourceLoader)

Overrides:

fontResourceLoader in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

Parameters:

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

Returns:

this, to continue building

build

public TableFormField build()

Builds the FormField

Specified by:

build in class FormField.FormFieldBuilder<List<com.github.tadukoo.util.pojo.OrderedMappedPojo>>

Returns:

A newly created FormField