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

Class StringFormField.StringFormFieldBuilder

java.lang.Object

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

com.github.tadukoo.view.form.field.StringFormField.StringFormFieldBuilder

Enclosing class:

StringFormField

public static class StringFormField.StringFormFieldBuilder
extends FormField.FormFieldBuilder<String>

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

StringFormField 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
stringFieldType	The type of String field	Defaults to StringFormField.StringFieldType.NORMAL
editable	Whether the field can be edited or not	Defaults to true
columns	Number of columns used to determine the width of the field	Defaults to -1 (to use the defaultValue for determining size)

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

Modifier and Type	Field	Description
private int	columns	Number of columns used to determine the width of the field
private boolean	editable	Whether the field can be edited or not
private StringFormField.StringFieldType	stringFieldType	The type of String 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	StringFormFieldBuilder()	Can't create StringFormFieldBuilder outside of StringFormField

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

stringFieldType

private StringFormField.StringFieldType stringFieldType

The type of String field

editable

private boolean editable

Whether the field can be edited or not

columns

private int columns

Number of columns used to determine the width of the field

Constructor Details

StringFormFieldBuilder

private StringFormFieldBuilder()

Can't create StringFormFieldBuilder outside of StringFormField

Method Details

key

public StringFormField.StringFormFieldBuilder key(String key)

Overrides:

key in class FormField.FormFieldBuilder<String>

Parameters:

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

Returns:

this, to continue building

defaultValue

public StringFormField.StringFormFieldBuilder defaultValue(String defaultValue)

Overrides:

defaultValue in class FormField.FormFieldBuilder<String>

Parameters:

defaultValue - The starting value of the field

Returns:

this, to continue building

labelType

public StringFormField.StringFormFieldBuilder labelType(LabelType labelType)

Overrides:

labelType in class FormField.FormFieldBuilder<String>

Parameters:

labelType - The LabelType to use for the field

Returns:

this, to continue building

labelForegroundPaint

public StringFormField.StringFormFieldBuilder labelForegroundPaint(SizablePaint labelForegroundPaint)

Overrides:

labelForegroundPaint in class FormField.FormFieldBuilder<String>

Parameters:

labelForegroundPaint - The SizablePaint for the foreground of the Label

Returns:

this, to continue building

labelBackgroundPaint

public StringFormField.StringFormFieldBuilder labelBackgroundPaint(SizablePaint labelBackgroundPaint)

Overrides:

labelBackgroundPaint in class FormField.FormFieldBuilder<String>

Parameters:

labelBackgroundPaint - The SizablePaint for the background of the Label

Returns:

this, to continue building

labelFont

public StringFormField.StringFormFieldBuilder labelFont(FontFamily labelFontFamily,
 int labelFontStyle,
 int labelFontSize)

Specifies the font to use on the Label

Overrides:

labelFont in class FormField.FormFieldBuilder<String>

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 StringFormField.StringFormFieldBuilder labelShape(ShapeInfo labelShape)

Overrides:

labelShape in class FormField.FormFieldBuilder<String>

Parameters:

labelShape - The ShapeInfo to use for the Label

Returns:

this, to continue building

labelBorder

public StringFormField.StringFormFieldBuilder labelBorder(Border labelBorder)

Overrides:

labelBorder in class FormField.FormFieldBuilder<String>

Parameters:

labelBorder - The Border to use for the Label

Returns:

this, to continue building

rowPos

public StringFormField.StringFormFieldBuilder rowPos(int rowPos)

Overrides:

rowPos in class FormField.FormFieldBuilder<String>

Parameters:

rowPos - The row position of the field

Returns:

this, to continue building

colPos

public StringFormField.StringFormFieldBuilder colPos(int colPos)

Overrides:

colPos in class FormField.FormFieldBuilder<String>

Parameters:

colPos - The column position of the field

Returns:

this, to continue building

rowSpan

public StringFormField.StringFormFieldBuilder rowSpan(int rowSpan)

Overrides:

rowSpan in class FormField.FormFieldBuilder<String>

Parameters:

rowSpan - The row span of the field

Returns:

this, to continue building

colSpan

public StringFormField.StringFormFieldBuilder colSpan(int colSpan)

Overrides:

colSpan in class FormField.FormFieldBuilder<String>

Parameters:

colSpan - The column span of the field

Returns:

this, to continue building

logFontResourceLoaderWarnings

public StringFormField.StringFormFieldBuilder logFontResourceLoaderWarnings(boolean logFontResourceLoaderWarnings)

Overrides:

logFontResourceLoaderWarnings in class FormField.FormFieldBuilder<String>

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

Overrides:

logger in class FormField.FormFieldBuilder<String>

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 StringFormField.StringFormFieldBuilder graphEnv(GraphicsEnvironment graphEnv)

Overrides:

graphEnv in class FormField.FormFieldBuilder<String>

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 StringFormField.StringFormFieldBuilder fontFolder(String fontFolder)

Overrides:

fontFolder in class FormField.FormFieldBuilder<String>

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 StringFormField.StringFormFieldBuilder fontResourceLoader(FontResourceLoader fontResourceLoader)

Overrides:

fontResourceLoader in class FormField.FormFieldBuilder<String>

Parameters:

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

Returns:

this, to continue building

stringFieldType

public StringFormField.StringFormFieldBuilder stringFieldType(StringFormField.StringFieldType stringFieldType)

Parameters:

stringFieldType - The type of String field

Returns:

this, to continue building

editable

public StringFormField.StringFormFieldBuilder editable(boolean editable)

Parameters:

editable - Whether the field can be edited or not

Returns:

this, to continue building

columns

public StringFormField.StringFormFieldBuilder columns(int columns)

Parameters:

columns - Number of columns used to determine the width of the field

Returns:

this, to continue building

build

public StringFormField build()

Builds the FormField

Specified by:

build in class FormField.FormFieldBuilder<String>

Returns:

A newly created FormField