Module com.dlsc.formsfx

Package com.dlsc.formsfx.model.structure

Class StringField

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.StringProperty,String,StringField>

com.dlsc.formsfx.model.structure.StringField

All Implemented Interfaces:

FormElement

public class StringField
extends DataField<javafx.beans.property.StringProperty,String,StringField>

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

Author:

Sacha Schmid, Rinesch Murugathas

Property Summary

Properties

Type	Property	Description
javafx.beans.property.BooleanProperty	multiline

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

Modifier and Type	Field	Description
protected javafx.beans.property.BooleanProperty	multiline

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	StringField(javafx.beans.property.SimpleStringProperty valueProperty, javafx.beans.property.SimpleStringProperty persistentValueProperty)	The constructor of StringField.

Method Summary

Modifier and Type	Method	Description
boolean	isMultiline()	Gets the value of the property multiline.
StringField	multiline(boolean newValue)	Sets whether the field is considered to be multiline or not.
javafx.beans.property.BooleanProperty	multilineProperty()

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, validateRequired, 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

Property Details

multiline

public javafx.beans.property.BooleanProperty multilineProperty

See Also:

isMultiline()

Field Details

multiline

protected final javafx.beans.property.BooleanProperty multiline

Constructor Details

StringField

protected StringField(javafx.beans.property.SimpleStringProperty valueProperty, javafx.beans.property.SimpleStringProperty persistentValueProperty)

The constructor of StringField.

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

multiline

public StringField multiline(boolean newValue)

Sets whether the field is considered to be multiline or not.

Parameters:

newValue - The new value for the multiline property.

Returns:

Returns the current field to allow for chaining.

isMultiline

public boolean isMultiline()

Gets the value of the property multiline.

Property description:

multilineProperty

public javafx.beans.property.BooleanProperty multilineProperty()

See Also:

isMultiline()