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

Class ButtonFormField

java.lang.Object

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

com.github.tadukoo.view.form.field.ButtonFormField

public class ButtonFormField
extends FormField<String>

Button Form Field is a FormField that is just a button

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 class	ButtonFormField.ButtonFormFieldBuilder	Builder to be used to create a ButtonFormField.

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 ActionListener	actionListener	The action to perform on click of the Button
private final SizablePaint	buttonBackgroundPaint	The SizablePaint to use for the background of the Button
private final Border	buttonBorder	The Border to use on the Button
private final SizablePaint	buttonDisabledTextPaint	The SizablePaint to use for disabled text on the Button
private final SizablePaint	buttonFocusPaint	The SizablePaint to use for when the Button is focused
private final FontFamily	buttonFontFamily	The FontFamily to use on the font of the Button
private final int	buttonFontSize	The font size to use on the font of the Button
private final int	buttonFontStyle	The font style to use on the font of the Button
private final SizablePaint	buttonForegroundPaint	The SizablePaint to use for the foreground of the Button
private final SizablePaint	buttonSelectPaint	The SizablePaint to use for when the Button is selected
private final ShapeInfo	buttonShape	The ShapeInfo to use on the Button

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ButtonFormField(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, ActionListener actionListener, SizablePaint buttonForegroundPaint, SizablePaint buttonBackgroundPaint, SizablePaint buttonSelectPaint, SizablePaint buttonFocusPaint, SizablePaint buttonDisabledTextPaint, FontFamily buttonFontFamily, int buttonFontStyle, int buttonFontSize, Border buttonBorder, ShapeInfo buttonShape)	Creates a new ButtonFormField with the given parameters

Method Summary

Modifier and Type	Method	Description
static ButtonFormField.ButtonFormFieldBuilder	builder()
ActionListener	getActionListener()
SizablePaint	getButtonBackgroundPaint()
Border	getButtonBorder()
SizablePaint	getButtonDisabledTextPaint()
SizablePaint	getButtonFocusPaint()
FontFamily	getButtonFontFamily()
int	getButtonFontSize()
int	getButtonFontStyle()
SizablePaint	getButtonForegroundPaint()
SizablePaint	getButtonSelectPaint()
ShapeInfo	getButtonShape()
JComponent	getComponent()	Creates the JComponent to be used for this field.
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.

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

actionListener

private final ActionListener actionListener

The action to perform on click of the Button

buttonForegroundPaint

private final SizablePaint buttonForegroundPaint

The SizablePaint to use for the foreground of the Button

buttonBackgroundPaint

private final SizablePaint buttonBackgroundPaint

The SizablePaint to use for the background of the Button

buttonSelectPaint

private final SizablePaint buttonSelectPaint

The SizablePaint to use for when the Button is selected

buttonFocusPaint

private final SizablePaint buttonFocusPaint

The SizablePaint to use for when the Button is focused

buttonDisabledTextPaint

private final SizablePaint buttonDisabledTextPaint

The SizablePaint to use for disabled text on the Button

buttonFontFamily

private final FontFamily buttonFontFamily

The FontFamily to use on the font of the Button

buttonFontStyle

private final int buttonFontStyle

The font style to use on the font of the Button

buttonFontSize

private final int buttonFontSize

The font size to use on the font of the Button

buttonBorder

private final Border buttonBorder

The Border to use on the Button

buttonShape

private final ShapeInfo buttonShape

The ShapeInfo to use on the Button

Constructor Details

ButtonFormField

private ButtonFormField(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,
 ActionListener actionListener,
 SizablePaint buttonForegroundPaint,
 SizablePaint buttonBackgroundPaint,
 SizablePaint buttonSelectPaint,
 SizablePaint buttonFocusPaint,
 SizablePaint buttonDisabledTextPaint,
 FontFamily buttonFontFamily,
 int buttonFontStyle,
 int buttonFontSize,
 Border buttonBorder,
 ShapeInfo buttonShape)

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

actionListener - The action to perform on click of the Button

buttonForegroundPaint - The SizablePaint to use for the foreground of the Button

buttonBackgroundPaint - The SizablePaint to use for the background of the Button

buttonSelectPaint - The SizablePaint to use for when the Button is selected

buttonFocusPaint - The SizablePaint to use for when the Button is focused

buttonDisabledTextPaint - The SizablePaint to use for disabled text on the Button

buttonFontFamily - The FontFamily to use on the font of the Button

buttonFontStyle - The font style to use on the font of the Button

buttonFontSize - The font size to use on the font of the Button

buttonBorder - The Border to use on the Button

buttonShape - The ShapeInfo to use on the Button

Method Details

builder

public static ButtonFormField.ButtonFormFieldBuilder builder()

Returns:

A new ButtonFormField.ButtonFormFieldBuilder to use to make a ButtonFormField

getActionListener

public ActionListener getActionListener()

Returns:

The action to perform on click of the Button

getButtonForegroundPaint

public SizablePaint getButtonForegroundPaint()

Returns:

The SizablePaint to use for the foreground of the Button

getButtonBackgroundPaint

public SizablePaint getButtonBackgroundPaint()

Returns:

The SizablePaint to use for the background of the Button

getButtonSelectPaint

public SizablePaint getButtonSelectPaint()

Returns:

The SizablePaint to use for when the Button is selected

getButtonFocusPaint

public SizablePaint getButtonFocusPaint()

Returns:

The SizablePaint to use for when the Button is focused

getButtonDisabledTextPaint

public SizablePaint getButtonDisabledTextPaint()

Returns:

The SizablePaint to use for disabled text on the Button

getButtonFontFamily

public FontFamily getButtonFontFamily()

Returns:

The FontFamily to use on the font of the Button

getButtonFontStyle

public int getButtonFontStyle()

Returns:

The font style to use on the font of the Button

getButtonFontSize

public int getButtonFontSize()

Returns:

The font size to use on the font of the Button

getButtonBorder

public Border getButtonBorder()

Returns:

The Border to use on the Button

getButtonShape

public ShapeInfo getButtonShape()

Returns:

The ShapeInfo to use on the Button

getComponent

public JComponent getComponent()
                        throws IOException,
FontFormatException

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

Throws:

IOException

FontFormatException

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