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

Class DateFormField

java.lang.Object

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

com.github.tadukoo.view.form.field.DateFormField

public class DateFormField
extends FormField<Date>

A Date Form Field is a FormField used to store Dates.

Since:

Alpha v.0.2.1

Version:

Alpha v.0.3

Author:

Logan Ferree (Tadukoo)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DateFormField.DateFormFieldBuilder	Builder to be used to create a DateFormField.

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	maxYear	The maximum year to allow on this field
private final int	minYear	The minimum year to allow on this field

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DateFormField(String key, Date 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, int minYear, int maxYear)	Creates a new DateFormField with the given parameters.

Method Summary

Modifier and Type	Method	Description
static DateFormField.DateFormFieldBuilder	builder()
JComponent	getComponent()	Creates the JComponent to be used for this field.
int	getMaxYear()
int	getMinYear()
Date	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.

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

minYear

private final int minYear

The minimum year to allow on this field

maxYear

private final int maxYear

The maximum year to allow on this field

Constructor Details

DateFormField

private DateFormField(String key,
 Date 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,
 int minYear,
 int maxYear)

Creates a new DateFormField 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

minYear - The minimum year to allow on this field

maxYear - The maximum year to allow on this field

Method Details

builder

public static DateFormField.DateFormFieldBuilder builder()

Returns:

A new DateFormField.DateFormFieldBuilder to use to make a DateFormField

getMinYear

public int getMinYear()

Returns:

The minimum year to allow on this field

getMaxYear

public int getMaxYear()

Returns:

The maximum year to allow on this field

getComponent

public JComponent getComponent()
                        throws Throwable

Creates the JComponent to be used for this field.

Specified by:

getComponent in class FormField<Date>

Returns:

A newly created JComponent to use on the form

Throws:

Throwable - If anything goes wrong setting up the Component

getValue

public Date 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<Date>

Parameters:

component - The JComponent associated with this field

Returns:

The data extracted from the JComponent