public final Class PasswordFieldEditor

Class Inheritance

extends Object

java.lang.Object
org.jabref.gui.preferences.forms.PasswordFieldEditor

Annotations

@NullMarked

Imports

java.util.function.Consumer, javafx.beans.property.StringProperty, javafx.scene.control.Button, javafx.scene.layout.HBox, org.jabref.gui.icon.IconTheme, .JabRefIcon, org.jabref.gui.util.ControlHelper, com.dlsc.gemsfx.EnhancedPasswordField, org.jspecify.annotations.NullMarked

Custom editor: a bound EnhancedPasswordField with an optional row of icon buttons in its right slot. EnhancedPasswordField is third-party, so the fluent subject is this wrapper; field() hands back the field once configuration is done — it does no work of its own, it just stops field from being reachable before the withers have run:

PasswordFieldEditor.create(viewModel.apiKeyProperty())
                   .withRevealButton()
                   .withClearButton()
                   .field();

Every button follows the field's own disabled state, so disabling the field disables the row.

Field Summary

Modifier and Type	Field and Description
private final HBox	buttons
private final EnhancedPasswordField	field

Constructor Summary

Access	Constructor and Description
private	PasswordFieldEditor(StringProperty value)

Method Summary

Modifier and Type	Method and Description
public static PasswordFieldEditor	create(StringProperty value)
public EnhancedPasswordField	field()
public PasswordFieldEditor	withClearButton() Empties the field and returns focus to it.
public PasswordFieldEditor	withIconButton(JabRefIcon icon, Consumer<EnhancedPasswordField> action)
public PasswordFieldEditor	withRevealButton() Toggles between masked and plain text.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

buttons	back to summary
private final HBox buttons

field	back to summary
private final EnhancedPasswordField field

Constructor Detail

PasswordFieldEditor	back to summary
private PasswordFieldEditor(StringProperty value)

Method Detail

create	back to summary
public static PasswordFieldEditor create(StringProperty value)

field	back to summary
public EnhancedPasswordField field()

withClearButton	back to summary
public PasswordFieldEditor withClearButton() Empties the field and returns focus to it.

withIconButton	back to summary
public PasswordFieldEditor withIconButton(JabRefIcon icon, Consumer<EnhancedPasswordField> action)

withRevealButton	back to summary
public PasswordFieldEditor withRevealButton() Toggles between masked and plain text.