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

Class FloatFormField

java.lang.Object

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

com.github.tadukoo.view.form.field.number.NumberFormField<Float>

com.github.tadukoo.view.form.field.number.FloatFormField

public class FloatFormField
extends NumberFormField<Float>

A Float Form Field is a FormField used to store floats.

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	FloatFormField.FloatFormFieldBuilder	Builder to be used to create an FloatFormField.

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

NumberFormField.NumberFormFieldBuilder<Type extends Number & Comparable<?>>

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

FormField.FormFieldBuilder<Type>

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FloatFormField(String key, Float 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, Float minValue, Float maxValue, Float stepSize)	Creates a new FloatFormField with the given parameters.

Method Summary

Modifier and Type	Method	Description
static FloatFormField.FloatFormFieldBuilder	builder()
protected Float	convertToType(Number number)	Used in NumberFormField.getValue(JComponent) to convert the Number from the JSpinner into the type used in this particular FormField.

Methods inherited from class com.github.tadukoo.view.form.field.number.NumberFormField

getComponent, getMaxValue, getMinValue, getStepSize, getValue

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

Constructor Details

FloatFormField

private FloatFormField(String key,
 Float 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,
 Float minValue,
 Float maxValue,
 Float stepSize)

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

minValue - The minimum value allowed for this field

maxValue - The maximum value allowed for this field

stepSize - The increment value for the spinner for this field

Method Details

builder

public static FloatFormField.FloatFormFieldBuilder builder()

Returns:

A new FloatFormField.FloatFormFieldBuilder to use to make a FloatFormField

convertToType

protected Float convertToType(Number number)

Used in NumberFormField.getValue(JComponent) to convert the Number from the JSpinner into the type used in this particular FormField.

Specified by:

convertToType in class NumberFormField<Float>

Parameters:

number - The Number we got from the JSpinner

Returns:

The number in its proper Type