UnitFX 1.0.10 · com.dlsc.unitfx.NumberInputField · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
pack-priv class	NumberInputField.NumberStringFilteredConverter Number string converter that provides a filter for text changes.

Modifier and Type	Field and Description
private final BooleanProperty	allowNegatives
private final ReadOnlyBooleanWrapper	invalid
private final ObjectProperty<T>	maximumValue
private final ObjectProperty<T>	minimumValue
private final IntegerProperty	numberOfDecimals
private final IntegerProperty	numberOfIntegers
private boolean	updatingValue
private final ObjectProperty<Predicate<T>>	validator
private final ObjectProperty<T>	value

Access	Constructor and Description
public	NumberInputField() Instances a new number input with with `null` `value`, no `validator` and allowing negatives.

Method Summary

Modifier and Type	Method and Description
public final BooleanProperty	Returns: The boolean property. allowNegativesProperty() Boolean property that tells the control to allow introducing a negative number.
protected abstract String	Returns: If the number is `null`, then return empty string. convertNumberToText(T The number to be converted. number) Converts the input number type object to string.
protected abstract T	Returns: In case of impossible conversion, return `null` instead of throwing exception. convertTextToNumber(String The text to be converted. text) Converts the text to the input field number type object.
public final T	getMaximumValue()
public final T	getMinimumValue()
public final int	getNumberOfDecimals()
public final int	getNumberOfIntegers()
public final Predicate<T>	getValidator()
public final T	getValue()
public final ReadOnlyBooleanProperty	Returns: The read only boolean property. invalidProperty() Property that indicates whether the `value` is valid after being validated by `validator`.
public final boolean	isAllowNegatives()
private boolean	isIntegerTypedField()
public final boolean	isInvalid()
private boolean	isInvalidNumber(T number)
private void	listenForAllowNegativeChanges()
private void	listenForTextOrValidationChanges()
private void	listenForValueChanges()
public final ObjectProperty<T>	Returns: The maximum value. maximumValueProperty() The maximum value that can be entered in this field.
public final ObjectProperty<T>	Returns: The minimum value. minimumValueProperty() The minimum value that can be entered in this field.
public final IntegerProperty	Returns: The maximum value. numberOfDecimalsProperty() The maximum digits in the decimal part of the number.
public final IntegerProperty	Returns: The maximum value. numberOfIntegersProperty() The maximum digits in the integer part of the number.
public final void	setAllowNegatives(boolean allowNegatives)
private final void	setInvalid(boolean invalid)
public final void	setMaximumValue(T maximumValue)
public final void	setMinimumValue(T minimumValue)
public final void	setNumberOfDecimals(int numberOfDecimals)
public final void	setNumberOfIntegers(int numberOfIntegers)
public final void	setValidator(Predicate<T> validator)
public final void	setValue(T value)
public final ObjectProperty<Predicate<T>>	Returns: The property storing the validator predicate. validatorProperty() Stores a validator object for the value converted from text entered.
public final ObjectProperty<T>	Returns: The number value. valueProperty() The number value representation of the text written.

Inherited from com.dlsc.unitfx.CustomTextField:: createDefaultSkin getLeft getRight leftProperty rightProperty setLeft setRight

allowNegatives	back to summary
private final BooleanProperty allowNegatives

invalid	back to summary
private final ReadOnlyBooleanWrapper invalid

maximumValue	back to summary
private final ObjectProperty<T> maximumValue

minimumValue	back to summary
private final ObjectProperty<T> minimumValue

numberOfDecimals	back to summary
private final IntegerProperty numberOfDecimals

numberOfIntegers	back to summary
private final IntegerProperty numberOfIntegers

updatingValue	back to summary
private boolean updatingValue

validator	back to summary
private final ObjectProperty<Predicate<T>> validator

value	back to summary
private final ObjectProperty<T> value

NumberInputField	back to summary
public NumberInputField() Instances a new number input with with `null` `value`, no `validator` and allowing negatives.

Method Detail

allowNegativesProperty	back to summary
public final BooleanProperty allowNegativesProperty() Boolean property that tells the control to allow introducing a negative number. Returns:BooleanProperty The boolean property.

allowNegativesProperty

back to summary

public final BooleanProperty allowNegativesProperty()

Boolean property that tells the control to allow introducing a negative number.

Returns:BooleanProperty: The boolean property.

convertNumberToText back to summary

convertNumberToText	back to summary
protected abstract String convertNumberToText(T number) Converts the input number type object to string. Parameters number:T The number to be converted. Returns:String If the number is `null`, then return empty string.

protected abstract String convertNumberToText(T number)

Converts the input number type object to string.

Parameters

number:T: The number to be converted.

Returns:String

If the number is null, then return empty string.

convertTextToNumber back to summary

convertTextToNumber	back to summary
protected abstract T convertTextToNumber(String text) Converts the text to the input field number type object. Parameters text:String The text to be converted. Returns:T In case of impossible conversion, return `null` instead of throwing exception.

protected abstract T convertTextToNumber(String text)

Converts the text to the input field number type object.

Parameters

text:String: The text to be converted.

Returns:T

In case of impossible conversion, return null instead of throwing exception.

getMaximumValue	back to summary
public final T getMaximumValue()

getMinimumValue	back to summary
public final T getMinimumValue()

getNumberOfDecimals	back to summary
public final int getNumberOfDecimals()

getNumberOfIntegers	back to summary
public final int getNumberOfIntegers()

getValidator	back to summary
public final Predicate<T> getValidator()

getValue	back to summary
public final T getValue()

invalidProperty back to summary

invalidProperty	back to summary
public final ReadOnlyBooleanProperty invalidProperty() Property that indicates whether the `value` is valid after being validated by `validator`. Returns:ReadOnlyBooleanProperty The read only boolean property.

public final ReadOnlyBooleanProperty invalidProperty()

Property that indicates whether the value is valid after being validated by validator.

Returns:ReadOnlyBooleanProperty: The read only boolean property.

isAllowNegatives	back to summary
public final boolean isAllowNegatives()

isIntegerTypedField	back to summary
private boolean isIntegerTypedField() Annotations @SuppressWarnings:unchecked

isInvalid	back to summary
public final boolean isInvalid()

isInvalidNumber	back to summary
private boolean isInvalidNumber(T number)

listenForAllowNegativeChanges	back to summary
private void listenForAllowNegativeChanges()

listenForTextOrValidationChanges	back to summary
private void listenForTextOrValidationChanges()

listenForValueChanges	back to summary
private void listenForValueChanges()

maximumValueProperty back to summary

maximumValueProperty	back to summary
public final ObjectProperty<T> maximumValueProperty() The maximum value that can be entered in this field. If this property is set, once the user enters a number greater than this minimum the field becomes invalid and the `valueProperty()` is set to `null`. Returns:ObjectProperty<T> The maximum value.

public final ObjectProperty<T> maximumValueProperty()

The maximum value that can be entered in this field. If this property is set, once the user enters a number greater than this minimum the field becomes invalid and the valueProperty() is set to null.

Returns:ObjectProperty<T>: The maximum value.

minimumValueProperty back to summary

minimumValueProperty	back to summary
public final ObjectProperty<T> minimumValueProperty() The minimum value that can be entered in this field. If this property is set, once the user enters a number lower than this minimum the field becomes invalid and the `valueProperty()` is set to `null`. Returns:ObjectProperty<T> The minimum value.

public final ObjectProperty<T> minimumValueProperty()

The minimum value that can be entered in this field. If this property is set, once the user enters a number lower than this minimum the field becomes invalid and the valueProperty() is set to null.

Returns:ObjectProperty<T>: The minimum value.

numberOfDecimalsProperty	back to summary
public final IntegerProperty numberOfDecimalsProperty() The maximum digits in the decimal part of the number. Returns:IntegerProperty The maximum value.

numberOfDecimalsProperty

back to summary

public final IntegerProperty numberOfDecimalsProperty()

The maximum digits in the decimal part of the number.

Returns:IntegerProperty: The maximum value.

numberOfIntegersProperty	back to summary
public final IntegerProperty numberOfIntegersProperty() The maximum digits in the integer part of the number. Returns:IntegerProperty The maximum value.

numberOfIntegersProperty

back to summary

public final IntegerProperty numberOfIntegersProperty()

The maximum digits in the integer part of the number.

Returns:IntegerProperty: The maximum value.

setAllowNegatives	back to summary
public final void setAllowNegatives(boolean allowNegatives)

setInvalid	back to summary
private final void setInvalid(boolean invalid)

setMaximumValue	back to summary
public final void setMaximumValue(T maximumValue)

setMinimumValue	back to summary
public final void setMinimumValue(T minimumValue)

setNumberOfDecimals	back to summary
public final void setNumberOfDecimals(int numberOfDecimals)

setNumberOfIntegers	back to summary
public final void setNumberOfIntegers(int numberOfIntegers)

setValidator	back to summary
public final void setValidator(Predicate<T> validator)

setValue	back to summary
public final void setValue(T value)

validatorProperty	back to summary
public final ObjectProperty<Predicate<T>> validatorProperty() Stores a validator object for the value converted from text entered. If the value entered is not valid, a pseudo class is added to the field, called ":invalid". This can be used for styling the field to indicate invalid inputs. Returns:ObjectProperty<Predicate<T>> The property storing the validator predicate.

validatorProperty

back to summary

public final ObjectProperty<Predicate<T>> validatorProperty()

Stores a validator object for the value converted from text entered. If the value entered is not valid, a pseudo class is added to the field, called ":invalid". This can be used for styling the field to indicate invalid inputs.

Returns:ObjectProperty<Predicate<T>>: The property storing the validator predicate.

valueProperty	back to summary
public final ObjectProperty<T> valueProperty() The number value representation of the text written. Returns:ObjectProperty<T> The number value.

valueProperty

back to summary

public final ObjectProperty<T> valueProperty()

The number value representation of the text written.

Returns:ObjectProperty<T>: The number value.

public abstract Class NumberInputField<T extends Number>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class NumberInputField.NumberStringFilteredConverter

Constructor Summary

Method Summary

Constructor Detail

Method Detail