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

Class DropDownFormField.DropDownFormFieldBuilder

java.lang.Object

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

com.github.tadukoo.view.form.field.DropDownFormField.DropDownFormFieldBuilder

Enclosing class:

DropDownFormField

public static class DropDownFormField.DropDownFormFieldBuilder
extends FormField.FormFieldBuilder<String>

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

DropDownFormField 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 - which converts to false for this field
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
editable	Whether the field can be edited or not	Defaults to true
options	The options to include in the drop-down list	Defaults to an empty array

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 boolean	editable	Whether the field can be edited or not
private String[]	options	The options to include in the drop-down list

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

editable

private boolean editable

Whether the field can be edited or not

options

private String[] options

The options to include in the drop-down list

Constructor Details

DropDownFormFieldBuilder

private DropDownFormFieldBuilder()

Not allowed to create a DropDownFormFieldBuilder outside of DropDownFormField

Method Details

key

public DropDownFormField.DropDownFormFieldBuilder 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 DropDownFormField.DropDownFormFieldBuilder 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 DropDownFormField.DropDownFormFieldBuilder 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 DropDownFormField.DropDownFormFieldBuilder 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 DropDownFormField.DropDownFormFieldBuilder 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 DropDownFormField.DropDownFormFieldBuilder 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 DropDownFormField.DropDownFormFieldBuilder 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 DropDownFormField.DropDownFormFieldBuilder 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 DropDownFormField.DropDownFormFieldBuilder 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 DropDownFormField.DropDownFormFieldBuilder 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 DropDownFormField.DropDownFormFieldBuilder 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 DropDownFormField.DropDownFormFieldBuilder 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 DropDownFormField.DropDownFormFieldBuilder 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 DropDownFormField.DropDownFormFieldBuilder 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 DropDownFormField.DropDownFormFieldBuilder 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 DropDownFormField.DropDownFormFieldBuilder 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 DropDownFormField.DropDownFormFieldBuilder 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

editable

public DropDownFormField.DropDownFormFieldBuilder editable(boolean editable)

Parameters:

editable - Whether the field can be edited or not

Returns:

this, to continue building

options

public DropDownFormField.DropDownFormFieldBuilder options(String[] options)

Parameters:

options - The options to include in the drop-down list

Returns:

this, to continue building

build

public DropDownFormField build()

Builds the FormField

Specified by:

build in class FormField.FormFieldBuilder<String>

Returns:

A newly created FormField