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

Class StringFormField

java.lang.Object

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

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

public class StringFormField
extends FormField<String>

String Form Field is a FormField that uses a String. This could be an input prompt or a title (See StringFormField.StringFieldType)

Since:

Alpha v.0.2

Version:

Alpha v.0.3

Author:

Logan Ferree (Tadukoo)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StringFormField.StringFieldType	String Field Type is used to determine type of String field
static class	StringFormField.StringFormFieldBuilder	Builder to be used to create a StringFormField.

Nested classes/interfaces inherited from class com.github.tadukoo.view.form.field.FormField

FormField.FormFieldBuilder<Type>

Field Summary

Fields

Modifier and Type	Field	Description
private final int	columns	Number of columns used to determine the width of this field
private final boolean	editable	Whether this field can be edited or not
private final StringFormField.StringFieldType	stringFieldType	The type of String field

Constructor Summary

Constructors

Modifier	Constructor	Description
private	StringFormField(String key, String defaultValue, LabelType labelType, SizablePaint labelForegroundPaint, SizablePaint labelBackgroundPaint, FontFamily labelFontFamily, int labelFontStyle, int labelFontSize, ShapeInfo labelShape, Border labelBorder, int rowPos, int colPos, int rowSpan, int colSpan, boolean logFontResourceLoaderWarnings, com.github.tadukoo.util.logger.EasyLogger logger, GraphicsEnvironment graphEnv, String fontFolder, FontResourceLoader fontResourceLoader, StringFormField.StringFieldType stringFieldType, boolean editable, int columns)	Creates a new StringFormField with the given parameters

Method Summary

Modifier and Type	Method	Description
static StringFormField.StringFormFieldBuilder	builder()
int	getColumns()
JComponent	getComponent()	Creates the JComponent to be used for this field.
StringFormField.StringFieldType	getStringFieldType()
String	getValue(JComponent component)	Takes in the JComponent for this field and grabs the data off of it, returning it in the proper format for the field to be repopulated on the form.
boolean	isEditable()

Methods inherited from class com.github.tadukoo.view.form.field.FormField

getColPos, getColSpan, getDefaultValue, getFontFolder, getFontResourceLoader, getGraphEnv, getKey, getLabelBackgroundPaint, getLabelBorder, getLabelFontFamily, getLabelFontSize, getLabelFontStyle, getLabelForegroundPaint, getLabelShape, getLabelType, getLogger, getRowPos, getRowSpan, getType, logFontResourceLoaderWarnings

Methods inherited from class java.lang.Object

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

Field Details

stringFieldType

private final StringFormField.StringFieldType stringFieldType

The type of String field

editable

private final boolean editable

Whether this field can be edited or not

columns

private final int columns

Number of columns used to determine the width of this field

Constructor Details

StringFormField

private StringFormField(String key,
 String defaultValue,
 LabelType labelType,
 SizablePaint labelForegroundPaint,
 SizablePaint labelBackgroundPaint,
 FontFamily labelFontFamily,
 int labelFontStyle,
 int labelFontSize,
 ShapeInfo labelShape,
 Border labelBorder,
 int rowPos,
 int colPos,
 int rowSpan,
 int colSpan,
 boolean logFontResourceLoaderWarnings,
 com.github.tadukoo.util.logger.EasyLogger logger,
 GraphicsEnvironment graphEnv,
 String fontFolder,
 FontResourceLoader fontResourceLoader,
 StringFormField.StringFieldType stringFieldType,
 boolean editable,
 int columns)

Creates a new StringFormField with the given parameters

Parameters:

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

defaultValue - The starting value of the field

labelType - The LabelType to use for this field

labelForegroundPaint - The SizablePaint for the foreground of the Label

labelBackgroundPaint - The SizablePaint for the background of the Label

labelFontFamily - The FontFamily for the Label's font

labelFontStyle - The font style for the Label

labelFontSize - The font size for the Label

labelShape - The ShapeInfo to use for the Label

labelBorder - The Border to use for the Label

rowPos - The row position of this field

colPos - The column position of this field

rowSpan - The row span of this field

colSpan - The column span of this field

logFontResourceLoaderWarnings - Whether to log warnings generated by the FontResourceLoader - can be ignored if you specify your own FontResourceLoader

logger - An EasyLogger that will be sent to the FontResourceLoader by default - can be ignored if you specify your own FontResourceLoader

graphEnv - The GraphicsEnvironment to load a font to in the FontResourceLoader - can be ignored if you specify your own FontResourceLoader

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

fontResourceLoader - The FontResourceLoader to use for fonts on this field

stringFieldType - The type of String field

editable - Whether this field can be edited or not

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

Method Details

builder

public static StringFormField.StringFormFieldBuilder builder()

Returns:

A new StringFormField.StringFormFieldBuilder to use to make a StringFormField

getStringFieldType

public StringFormField.StringFieldType getStringFieldType()

Returns:

The type of String field

isEditable

public boolean isEditable()

Returns:

Whether this field can be edited or not

getColumns

public int getColumns()

Returns:

Number of columns used to determine the width of the field

getComponent

public JComponent getComponent()

Creates the JComponent to be used for this field.

Specified by:

getComponent in class FormField<String>

Returns:

A newly created JComponent to use on the form

getValue

public String getValue(JComponent component)

Takes in the JComponent for this field and grabs the data off of it, returning it in the proper format for the field to be repopulated on the form.

Specified by:

getValue in class FormField<String>

Parameters:

component - The JComponent associated with this field

Returns:

The data extracted from the JComponent