Module com.dlsc.formsfx

Package com.dlsc.formsfx.model.structure

Class BooleanField

java.lang.Object

com.dlsc.formsfx.model.structure.Element<F>

com.dlsc.formsfx.model.structure.Field<F>

com.dlsc.formsfx.model.structure.DataField<javafx.beans.property.BooleanProperty,Boolean,BooleanField>

com.dlsc.formsfx.model.structure.BooleanField

All Implemented Interfaces:

FormElement

public class BooleanField
extends DataField<javafx.beans.property.BooleanProperty,Boolean,BooleanField>

This class provides an implementation of a Field containing a boolean value.

Author:

Sacha Schmid, Rinesch Murugathas

Property Summary

Properties inherited from class com.dlsc.formsfx.model.structure.DataField

userInput, value

Properties inherited from class com.dlsc.formsfx.model.structure.Field

changed, editable, errorMessages, label, placeholder, required, tooltip, valid

Properties inherited from class com.dlsc.formsfx.model.structure.Element

id, span, styleClass

Nested Class Summary

Nested classes/interfaces inherited from class com.dlsc.formsfx.model.structure.DataField

DataField.AbstractStringConverter<V>

Field Summary

Fields inherited from class com.dlsc.formsfx.model.structure.DataField

formatError, formatErrorKey, persistentValue, stringConverter, userInput, validators, value

Fields inherited from class com.dlsc.formsfx.model.structure.Field

bindingModeListener, changed, editable, errorMessageKeys, errorMessages, eventHandlers, id, label, labelKey, placeholder, placeholderKey, renderer, rendererSupplier, required, requiredError, requiredErrorKey, span, styleClass, tooltip, tooltipKey, translationService, valid

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BooleanField(javafx.beans.property.SimpleBooleanProperty valueProperty, javafx.beans.property.SimpleBooleanProperty persistentValueProperty)	The constructor of BooleanField.

Method Summary

Modifier and Type	Method	Description
protected boolean	validateRequired(String newValue)	Validates that the new field input matches the required condition.

Methods inherited from class com.dlsc.formsfx.model.structure.DataField

bind, format, format, format, format, format, getUserInput, getValue, persist, reset, setBindingMode, translate, unbind, userInputProperty, validate, validate, valueProperty

Methods inherited from class com.dlsc.formsfx.model.structure.Field

addEventHandler, changedProperty, editable, editableProperty, errorMessagesProperty, fireEvent, getErrorMessages, getLabel, getLabelDescription, getPlaceholder, getRenderer, getTooltip, getValueDescription, hasChanged, isEditable, isI18N, isRequired, isValid, label, labelDescription, labelDescription, labelProperty, ofBooleanType, ofBooleanType, ofDate, ofDate, ofDoubleType, ofDoubleType, ofIntegerType, ofIntegerType, ofMultiSelectionType, ofMultiSelectionType, ofMultiSelectionType, ofPasswordType, ofPasswordType, ofSingleSelectionType, ofSingleSelectionType, ofSingleSelectionType, ofStringType, ofStringType, placeholder, placeholderProperty, removeEventHandler, render, render, required, required, requiredProperty, tooltip, tooltipProperty, updateElement, validProperty, valueDescription, valueDescription

Methods inherited from class com.dlsc.formsfx.model.structure.Element

getID, getSpan, getStyleClass, id, idProperty, span, span, spanProperty, styleClass, styleClassProperty

Methods inherited from class java.lang.Object

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

Constructor Details

BooleanField

protected BooleanField(javafx.beans.property.SimpleBooleanProperty valueProperty, javafx.beans.property.SimpleBooleanProperty persistentValueProperty)

The constructor of BooleanField.

Parameters:

valueProperty - The property that is used to store the current valid value of the field.

persistentValueProperty - The property that is used to store the latest persisted value of the field.

Method Details

validateRequired

protected boolean validateRequired(String newValue)

Validates that the new field input matches the required condition.

Overrides:

validateRequired in class DataField<javafx.beans.property.BooleanProperty,Boolean,BooleanField>

Parameters:

newValue - The new value to check for the required state.

Returns:

Returns whether the input matches the required condition.