Class ButtonFormField.ButtonFormFieldBuilder
java.lang.Object
com.github.tadukoo.view.form.field.FormField.FormFieldBuilder<String>
com.github.tadukoo.view.form.field.ButtonFormField.ButtonFormFieldBuilder
- Enclosing class:
- ButtonFormField
public static class ButtonFormField.ButtonFormFieldBuilder
extends FormField.FormFieldBuilder<String>
Builder to be used to create a
This builder also provides methods and parameters for
ButtonFormField
. It has the following 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 |
labelType | The LabelType to use for the field |
Defaults to LabelType.NONE |
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 |
actionListener | The action to perform on click of the Button | Defaults to null (no action) |
buttonForegroundPaint | The SizablePaint to use for the foreground of the Button |
Defaults to null (to use the Look & Feel's default Button foreground paint) |
buttonBackgroundPaint | The SizablePaint to use for the background of the Button |
Defaults to null (to use the Look & Feel's default Button background paint) |
buttonSelectPaint | The SizablePaint to use for when the Button is selected |
Defaults to null (to use the Look & Feel's default Button select paint) |
buttonFocusPaint | The SizablePaint to use for when the Button is focused |
Defaults to null (to use the Look & Feel's default Button focus paint) |
buttonDisabledTextPaint | The SizablePaint to use for disabled text on the Button |
Defaults to null (to use the Look & Feel's default Button disabled text paint) |
buttonFont | The Font to use on the Button (specified via FontFamily , font style,
and font size |
Defaults to null (to use the Look & Feel's default Button font) |
buttonBorder | The Border to use on the Button |
Defaults to null (to use the Look & Feel's default Button border) |
buttonShape | The ShapeInfo to use on the Button |
Defaults to null (to use the Look & Feel's default Button shape) |
font resource loading
:
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
Modifier and TypeFieldDescriptionprivate ActionListener
The action to perform on click of the Buttonprivate SizablePaint
TheSizablePaint
to use for the background of the Buttonprivate Border
TheBorder
to use on the Buttonprivate SizablePaint
TheSizablePaint
to use for disabled text on the Buttonprivate SizablePaint
TheSizablePaint
to use for when the Button is focusedprivate FontFamily
TheFontFamily
to use on the font of the Buttonprivate int
The font size to use on the font of the Buttonprivate int
The font style to use on the font of the Buttonprivate SizablePaint
TheSizablePaint
to use for the foreground of the Buttonprivate SizablePaint
TheSizablePaint
to use for when the Button is selectedprivate ShapeInfo
TheShapeInfo
to use on the ButtonFields 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
ModifierConstructorDescriptionprivate
Not allowed to create ButtonFormFieldBuilder outside of ButtonFormField -
Method Summary
Modifier and TypeMethodDescriptionactionListener
(ActionListener actionListener) build()
Builds theFormField
buttonBackgroundPaint
(SizablePaint buttonBackgroundPaint) buttonBorder
(Border buttonBorder) buttonDisabledTextPaint
(SizablePaint buttonDisabledTextPaint) buttonFocusPaint
(SizablePaint buttonFocusPaint) buttonFont
(FontFamily buttonFontFamily, int buttonFontStyle, int buttonFontSize) Specifies the font to use on the ButtonbuttonForegroundPaint
(SizablePaint buttonForegroundPaint) buttonSelectPaint
(SizablePaint buttonSelectPaint) buttonShape
(ShapeInfo buttonShape) colPos
(int colPos) colSpan
(int colSpan) defaultValue
(String defaultValue) fontFolder
(String fontFolder) fontResourceLoader
(FontResourceLoader fontResourceLoader) graphEnv
(GraphicsEnvironment graphEnv) labelBackgroundPaint
(SizablePaint labelBackgroundPaint) labelBorder
(Border labelBorder) labelFont
(FontFamily labelFontFamily, int labelFontStyle, int labelFontSize) Specifies the font to use on the LabellabelForegroundPaint
(SizablePaint labelForegroundPaint) labelShape
(ShapeInfo labelShape) logFontResourceLoaderWarnings
(boolean logFontResourceLoaderWarnings) logger
(com.github.tadukoo.util.logger.EasyLogger logger) rowPos
(int rowPos) rowSpan
(int rowSpan)
-
Field Details
-
actionListener
The action to perform on click of the Button -
buttonForegroundPaint
TheSizablePaint
to use for the foreground of the Button -
buttonBackgroundPaint
TheSizablePaint
to use for the background of the Button -
buttonSelectPaint
TheSizablePaint
to use for when the Button is selected -
buttonFocusPaint
TheSizablePaint
to use for when the Button is focused -
buttonDisabledTextPaint
TheSizablePaint
to use for disabled text on the Button -
buttonFontFamily
TheFontFamily
to use on the font of the Button -
buttonFontStyle
private int buttonFontStyleThe font style to use on the font of the Button -
buttonFontSize
private int buttonFontSizeThe font size to use on the font of the Button -
buttonBorder
TheBorder
to use on the Button -
buttonShape
TheShapeInfo
to use on the Button
-
-
Constructor Details
-
ButtonFormFieldBuilder
private ButtonFormFieldBuilder()Not allowed to create ButtonFormFieldBuilder outside of ButtonFormField
-
-
Method Details
-
key
- Overrides:
key
in classFormField.FormFieldBuilder<String>
- Parameters:
key
- The name of the field (used as a key inForms
)- Returns:
- this, to continue building
-
defaultValue
- Overrides:
defaultValue
in classFormField.FormFieldBuilder<String>
- Parameters:
defaultValue
- The starting value of the field- Returns:
- this, to continue building
-
labelType
- Overrides:
labelType
in classFormField.FormFieldBuilder<String>
- Parameters:
labelType
- TheLabelType
to use for the field- Returns:
- this, to continue building
-
labelForegroundPaint
public ButtonFormField.ButtonFormFieldBuilder labelForegroundPaint(SizablePaint labelForegroundPaint) - Overrides:
labelForegroundPaint
in classFormField.FormFieldBuilder<String>
- Parameters:
labelForegroundPaint
- TheSizablePaint
for the foreground of the Label- Returns:
- this, to continue building
-
labelBackgroundPaint
public ButtonFormField.ButtonFormFieldBuilder labelBackgroundPaint(SizablePaint labelBackgroundPaint) - Overrides:
labelBackgroundPaint
in classFormField.FormFieldBuilder<String>
- Parameters:
labelBackgroundPaint
- TheSizablePaint
for the background of the Label- Returns:
- this, to continue building
-
labelFont
public ButtonFormField.ButtonFormFieldBuilder labelFont(FontFamily labelFontFamily, int labelFontStyle, int labelFontSize) Specifies the font to use on the Label- Overrides:
labelFont
in classFormField.FormFieldBuilder<String>
- Parameters:
labelFontFamily
- TheFontFamily
for the Label's fontlabelFontStyle
- The font style for the LabellabelFontSize
- The font size for the Label- Returns:
- this, to continue building
-
labelShape
- Overrides:
labelShape
in classFormField.FormFieldBuilder<String>
- Parameters:
labelShape
- TheShapeInfo
to use for the Label- Returns:
- this, to continue building
-
labelBorder
- Overrides:
labelBorder
in classFormField.FormFieldBuilder<String>
- Parameters:
labelBorder
- TheBorder
to use for the Label- Returns:
- this, to continue building
-
rowPos
- Overrides:
rowPos
in classFormField.FormFieldBuilder<String>
- Parameters:
rowPos
- The row position of the field- Returns:
- this, to continue building
-
colPos
- Overrides:
colPos
in classFormField.FormFieldBuilder<String>
- Parameters:
colPos
- The column position of the field- Returns:
- this, to continue building
-
rowSpan
- Overrides:
rowSpan
in classFormField.FormFieldBuilder<String>
- Parameters:
rowSpan
- The row span of the field- Returns:
- this, to continue building
-
colSpan
- Overrides:
colSpan
in classFormField.FormFieldBuilder<String>
- Parameters:
colSpan
- The column span of the field- Returns:
- this, to continue building
-
logFontResourceLoaderWarnings
public ButtonFormField.ButtonFormFieldBuilder logFontResourceLoaderWarnings(boolean logFontResourceLoaderWarnings) - Overrides:
logFontResourceLoaderWarnings
in classFormField.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 ButtonFormField.ButtonFormFieldBuilder logger(com.github.tadukoo.util.logger.EasyLogger logger) - Overrides:
logger
in classFormField.FormFieldBuilder<String>
- Parameters:
logger
- AnEasyLogger
that will be sent to the FontResourceLoader by default - can be ignored if you specify your own FontResourceLoader- Returns:
- this, to continue building
-
graphEnv
- Overrides:
graphEnv
in classFormField.FormFieldBuilder<String>
- Parameters:
graphEnv
- TheGraphicsEnvironment
to load fonts to in the FontResourceLoader - can be ignored if you specify your own FontResourceLoader- Returns:
- this, to continue building
-
fontFolder
- Overrides:
fontFolder
in classFormField.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 ButtonFormField.ButtonFormFieldBuilder fontResourceLoader(FontResourceLoader fontResourceLoader) - Overrides:
fontResourceLoader
in classFormField.FormFieldBuilder<String>
- Parameters:
fontResourceLoader
- TheFontResourceLoader
to use in loading fonts and/or ensuring they're in the system- Returns:
- this, to continue building
-
actionListener
- Parameters:
actionListener
- The action to perform on click of the Button- Returns:
- this, to continue building
-
buttonForegroundPaint
public ButtonFormField.ButtonFormFieldBuilder buttonForegroundPaint(SizablePaint buttonForegroundPaint) - Parameters:
buttonForegroundPaint
- TheSizablePaint
to use for the foreground of the Button- Returns:
- this, to continue building
-
buttonBackgroundPaint
public ButtonFormField.ButtonFormFieldBuilder buttonBackgroundPaint(SizablePaint buttonBackgroundPaint) - Parameters:
buttonBackgroundPaint
- TheSizablePaint
to use for the background of the Button- Returns:
- this, to continue building
-
buttonSelectPaint
- Parameters:
buttonSelectPaint
- TheSizablePaint
to use for when the Button is selected- Returns:
- this, to continue building
-
buttonFocusPaint
- Parameters:
buttonFocusPaint
- TheSizablePaint
to use for when the Button is focused- Returns:
- this, to continue building
-
buttonDisabledTextPaint
public ButtonFormField.ButtonFormFieldBuilder buttonDisabledTextPaint(SizablePaint buttonDisabledTextPaint) - Parameters:
buttonDisabledTextPaint
- TheSizablePaint
to use for disabled text on the Button- Returns:
- this, to continue building
-
buttonFont
public ButtonFormField.ButtonFormFieldBuilder buttonFont(FontFamily buttonFontFamily, int buttonFontStyle, int buttonFontSize) Specifies the font to use on the Button- Parameters:
buttonFontFamily
- TheFontFamily
to usebuttonFontStyle
- The font style to usebuttonFontSize
- The font size to use- Returns:
- this, to continue building
-
buttonBorder
- Parameters:
buttonBorder
- TheBorder
to use on the Button- Returns:
- this, to continue building
-
buttonShape
- Parameters:
buttonShape
- TheShapeInfo
to use on the Button- Returns:
- this, to continue building
-
build
Builds theFormField
- Specified by:
build
in classFormField.FormFieldBuilder<String>
- Returns:
- A newly created
FormField
-