Class PasswordTextFormatter

java.lang.Object

javafx.scene.control.TextFormatter<String>

atlantafx.base.util.PasswordTextFormatter

public class PasswordTextFormatter
extends javafx.scene.control.TextFormatter<String>

An alternative to the PasswordField class. This formatter masks or unmasks text field content based on a boolean property.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	PasswordTextFormatter.PasswordFilter
protected static class	PasswordTextFormatter.PasswordStringConverter

Nested classes/interfaces inherited from class javafx.scene.control.TextFormatter

javafx.scene.control.TextFormatter.Change

Property Summary

Properties

Type	Property	Description
javafx.beans.property.ReadOnlyStringProperty	password	Always returns the unmasked password text regardless of the revealPasswordProperty() state.
javafx.beans.property.BooleanProperty	revealPassword	Specifies whether the unmasked password text is revealed or not.

Properties inherited from class javafx.scene.control.TextFormatter

value

Field Summary

Fields

Modifier and Type	Field	Description
static final char	BULLET

Fields inherited from class javafx.scene.control.TextFormatter

IDENTITY_STRING_CONVERTER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PasswordTextFormatter(javafx.util.StringConverter<String> valueConverter, UnaryOperator<javafx.scene.control.TextFormatter.Change> filter, javafx.scene.control.TextField field, char bullet)

Method Summary

Modifier and Type	Method	Description
static PasswordTextFormatter	create(javafx.scene.control.TextField textField)	Creates a new password text formatter with the default mask character and applies itself to the specified text field.
static PasswordTextFormatter	create(javafx.scene.control.TextField field, char bullet)	Creates a new password text formatter with the provided mask character and applies itself to the specified text field.
String	getPassword()	See passwordProperty().
boolean	getRevealPassword()	See revealPasswordProperty().
javafx.beans.property.ReadOnlyStringProperty	passwordProperty()	Always returns the unmasked password text regardless of the revealPasswordProperty() state.
javafx.beans.property.BooleanProperty	revealPasswordProperty()	Specifies whether the unmasked password text is revealed or not.
void	setRevealPassword(boolean reveal)	See revealPasswordProperty().

Methods inherited from class javafx.scene.control.TextFormatter

getFilter, getValue, getValueConverter, setValue, valueProperty

Methods inherited from class Object

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

Property Details

password

public javafx.beans.property.ReadOnlyStringProperty passwordProperty

Always returns the unmasked password text regardless of the revealPasswordProperty() state.

See Also:

• getPassword()
• passwordProperty()

revealPassword

public javafx.beans.property.BooleanProperty revealPasswordProperty

Specifies whether the unmasked password text is revealed or not.

See Also:

• getRevealPassword()
• setRevealPassword(boolean)
• revealPasswordProperty()

Field Details

BULLET

public static final char BULLET

See Also:

• Constant Field Values

Constructor Details

PasswordTextFormatter

protected PasswordTextFormatter(javafx.util.StringConverter<String> valueConverter,
 UnaryOperator<javafx.scene.control.TextFormatter.Change> filter,
 javafx.scene.control.TextField field,
 char bullet)

Method Details

passwordProperty

public javafx.beans.property.ReadOnlyStringProperty passwordProperty()

Always returns the unmasked password text regardless of the revealPasswordProperty() state.

Returns:

the password property

See Also:

• getPassword()

getPassword

public String getPassword()

See passwordProperty().

revealPasswordProperty

public javafx.beans.property.BooleanProperty revealPasswordProperty()

Specifies whether the unmasked password text is revealed or not.

Returns:

the revealPassword property

See Also:

• getRevealPassword()
• setRevealPassword(boolean)

getRevealPassword

public boolean getRevealPassword()

See revealPasswordProperty().

setRevealPassword

public void setRevealPassword(boolean reveal)

See revealPasswordProperty().

create

public static PasswordTextFormatter create(javafx.scene.control.TextField field,
 char bullet)

Creates a new password text formatter with the provided mask character and applies itself to the specified text field.

create

public static PasswordTextFormatter create(javafx.scene.control.TextField textField)

Creates a new password text formatter with the default mask character and applies itself to the specified text field.