Verified Owner
Top Fields Constructors Methods
org.jabref.gui.libraryproperties.general

public Class GeneralPropertiesViewModel

extends Object
implements PropertiesTabViewModel
Class Inheritance
All Implemented Interfaces
org.jabref.gui.libraryproperties.PropertiesTabViewModel
Imports
java.nio.charset.Charset, .StandardCharsets, java.nio.file.Files, .InvalidPathException, .Path, java.util.Optional, javafx.beans.property.BooleanProperty, .ListProperty, .ObjectProperty, .SimpleBooleanProperty, .SimpleListProperty, .SimpleObjectProperty, .SimpleStringProperty, .StringProperty, javafx.collections.FXCollections, org.jabref.gui.DialogService, org.jabref.gui.libraryproperties.PropertiesTabViewModel, org.jabref.gui.util.DirectoryDialogConfiguration, org.jabref.logic.formatter.bibtexfields.KeywordSeparatorMigration, org.jabref.logic.l10n.Localization, org.jabref.logic.os.OS, org.jabref.logic.preferences.CliPreferences, org.jabref.logic.shared.DatabaseLocation, org.jabref.logic.undo.UndoManager, org.jabref.model.database.BibDatabaseContext, .BibDatabaseMode, org.jabref.model.metadata.MetaData, org.jabref.model.undo.UndoableFieldChange, de.saxsys.mvvmfx.utils.validation.FunctionBasedValidator, de.saxsys.mvvmfx.utils.validation.ValidationMessage, de.saxsys.mvvmfx.utils.validation.ValidationStatus, de.saxsys.mvvmfx.utils.validation.Validator

Field Summary

Modifier and TypeField and Description
private final BibDatabaseContext
private final ListProperty<BibDatabaseMode>
private final DialogService
private final BooleanProperty
private final ListProperty<Charset>
private final StringProperty
private final StringProperty
private final de.saxsys.mvvmfx.utils.validation.Validator
private final StringProperty
private final de.saxsys.mvvmfx.utils.validation.Validator
private final CliPreferences
private final SimpleObjectProperty<BibDatabaseMode>
private final ObjectProperty<Charset>
private final UndoManager
private final StringProperty
private final de.saxsys.mvvmfx.utils.validation.Validator

Constructor Summary

AccessConstructor and Description
pack-priv
GeneralPropertiesViewModel(BibDatabaseContext databaseContext, DialogService dialogService, CliPreferences preferences, UndoManager undoManager)

Method Summary

Modifier and TypeMethod and Description
public void
public void
public void
public ListProperty<BibDatabaseMode>
public BooleanProperty
public ListProperty<Charset>
private Path
getBrowseDirectory(String configuredDir)

public StringProperty
public StringProperty
pack-priv de.saxsys.mvvmfx.utils.validation.ValidationStatus
public StringProperty
pack-priv de.saxsys.mvvmfx.utils.validation.ValidationStatus
private boolean
promptUserToConfirmAction(de.saxsys.mvvmfx.utils.validation.ValidationStatus status)

public SimpleObjectProperty<BibDatabaseMode>
public ObjectProperty<Charset>
private void
setDirectory(StringProperty
file directory to be updated (lib/user/laTex)
fileDirectory
,
Path
path of directory (selected by user)
selectedDirPath
)

For a saved library, any directory relative to the library path will be set as relative; otherwise, it will be set as absolute.

public void
private void
storeKeywordSeparator(MetaData metaData)

The separator and the group definitions the migration rewrites are both metadata, so the snapshot the dialog records covers them; only the entries it rewrites are recorded here, and they join the dialog's step.

public void
public void
togglePath(StringProperty fileDirectory)

public StringProperty
pack-priv de.saxsys.mvvmfx.utils.validation.ValidationStatus
private de.saxsys.mvvmfx.utils.validation.ValidationMessage
validateDirectory(String directoryPath, String messageKey)

public boolean
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

databaseContextback to summary
private final BibDatabaseContext databaseContext
databaseModesPropertyback to summary
private final ListProperty<BibDatabaseMode> databaseModesProperty
dialogServiceback to summary
private final DialogService dialogService
encodingDisablePropertyback to summary
private final BooleanProperty encodingDisableProperty
encodingsPropertyback to summary
private final ListProperty<Charset> encodingsProperty
keywordSeparatorPropertyback to summary
private final StringProperty keywordSeparatorProperty
laTexFileDirectoryPropertyback to summary
private final StringProperty laTexFileDirectoryProperty
laTexFileDirectoryValidatorback to summary
private final de.saxsys.mvvmfx.utils.validation.Validator laTexFileDirectoryValidator
librarySpecificDirectoryPropertyback to summary
private final StringProperty librarySpecificDirectoryProperty
librarySpecificFileDirectoryValidatorback to summary
private final de.saxsys.mvvmfx.utils.validation.Validator librarySpecificFileDirectoryValidator
preferencesback to summary
private final CliPreferences preferences
selectedDatabaseModePropertyback to summary
private final SimpleObjectProperty<BibDatabaseMode> selectedDatabaseModeProperty
selectedEncodingPropertyback to summary
private final ObjectProperty<Charset> selectedEncodingProperty
undoManagerback to summary
private final UndoManager undoManager
userSpecificFileDirectoryPropertyback to summary
private final StringProperty userSpecificFileDirectoryProperty
userSpecificFileDirectoryValidatorback to summary
private final de.saxsys.mvvmfx.utils.validation.Validator userSpecificFileDirectoryValidator

Constructor Detail

GeneralPropertiesViewModelback to summary
pack-priv GeneralPropertiesViewModel(BibDatabaseContext databaseContext, DialogService dialogService, CliPreferences preferences, UndoManager undoManager)

Method Detail

browseLatexDirback to summary
public void browseLatexDir()
browseLibrarySpecificDirback to summary
public void browseLibrarySpecificDir()
browseUserDirback to summary
public void browseUserDir()
databaseModesPropertyback to summary
public ListProperty<BibDatabaseMode> databaseModesProperty()
encodingDisablePropertyback to summary
public BooleanProperty encodingDisableProperty()
encodingsPropertyback to summary
public ListProperty<Charset> encodingsProperty()
getBrowseDirectoryback to summary
private Path getBrowseDirectory(String configuredDir)
keywordSeparatorPropertyback to summary
public StringProperty keywordSeparatorProperty()
laTexFileDirectoryPropertyback to summary
public StringProperty laTexFileDirectoryProperty()
laTexFileDirectoryStatusback to summary
pack-priv de.saxsys.mvvmfx.utils.validation.ValidationStatus laTexFileDirectoryStatus()
librarySpecificDirectoryPropertyback to summary
public StringProperty librarySpecificDirectoryProperty()
librarySpecificFileDirectoryStatusback to summary
pack-priv de.saxsys.mvvmfx.utils.validation.ValidationStatus librarySpecificFileDirectoryStatus()
promptUserToConfirmActionback to summary
private boolean promptUserToConfirmAction(de.saxsys.mvvmfx.utils.validation.ValidationStatus status)
selectedDatabaseModePropertyback to summary
public SimpleObjectProperty<BibDatabaseMode> selectedDatabaseModeProperty()
selectedEncodingPropertyback to summary
public ObjectProperty<Charset> selectedEncodingProperty()
setDirectoryback to summary
private void setDirectory(StringProperty fileDirectory, Path selectedDirPath)

For a saved library, any directory relative to the library path will be set as relative; otherwise, it will be set as absolute.

Parameters
fileDirectory:StringProperty

file directory to be updated (lib/user/laTex)

selectedDirPath:Path

path of directory (selected by user)

setValuesback to summary
public void setValues(MetaData metaData)

Implements org.jabref.gui.libraryproperties.PropertiesTabViewModel.setValues.

Doc from org.jabref.gui.libraryproperties.PropertiesTabViewModel.setValues.

Fills this tab's controls from metaData — see PropertiesTab#setValues(MetaData).

Annotations
@Override
storeKeywordSeparatorback to summary
private void storeKeywordSeparator(MetaData metaData)

The separator and the group definitions the migration rewrites are both metadata, so the snapshot the dialog records covers them; only the entries it rewrites are recorded here, and they join the dialog's step.

storeSettingsback to summary
public void storeSettings(MetaData metaData)

Implements org.jabref.gui.libraryproperties.PropertiesTabViewModel.storeSettings.

Doc from org.jabref.gui.libraryproperties.PropertiesTabViewModel.storeSettings.

Writes this tab's settings into metaData — see PropertiesTab#storeSettings(MetaData). A tab whose settings are not metadata, such as the preamble, ignores it and records its own change.

Annotations
@Override
togglePathback to summary
public void togglePath(StringProperty fileDirectory)
userSpecificFileDirectoryPropertyback to summary
public StringProperty userSpecificFileDirectoryProperty()
userSpecificFileDirectoryStatusback to summary
pack-priv de.saxsys.mvvmfx.utils.validation.ValidationStatus userSpecificFileDirectoryStatus()
validateDirectoryback to summary
private de.saxsys.mvvmfx.utils.validation.ValidationMessage validateDirectory(String directoryPath, String messageKey)
validateSettingsback to summary
public boolean validateSettings()

Overrides default org.jabref.gui.libraryproperties.PropertiesTabViewModel.validateSettings.

Annotations
@Override