Verified Owner
Top Description Fields Constructors Methods
org.jabref.logic

public Class FilePreferences

extends Object
Class Inheritance
Annotations
@NullMarked
Imports
java.nio.file.Path, java.util.Optional, javafx.beans.property.BooleanProperty, .ObjectProperty, .ReadOnlyObjectProperty, .SimpleBooleanProperty, .SimpleObjectProperty, .SimpleStringProperty, .StringProperty, org.jabref.logic.os.OS, org.jabref.logic.util.Directories, org.jabref.model.metadata.UserHostInfo, org.jspecify.annotations.NullMarked, .Nullable

Preferences for the linked files

Field Summary

Modifier and TypeField and Description
private final BooleanProperty
private final BooleanProperty
private final ObjectProperty<Path>
private final BooleanProperty
private final BooleanProperty
private final BooleanProperty
public static final String[]
private final BooleanProperty
private final StringProperty
private final StringProperty
private final BooleanProperty
private final ObjectProperty<Path>
private final ObjectProperty<@Nullable Path>
private final BooleanProperty
private final BooleanProperty
private final BooleanProperty
private final BooleanProperty
private final BooleanProperty
private final BooleanProperty
private final SimpleObjectProperty<UserHostInfo>
private final ObjectProperty<Path>

Constructor Summary

AccessConstructor and Description
private
public
FilePreferences(ReadOnlyObjectProperty<UserHostInfo> userAndHost, @Nullable Path mainFileDirectory, boolean storeFilesRelativeToBibFile, boolean autoRenameFilesOnChange, String fileNamePattern, String fileDirectoryPattern, boolean downloadLinkedFiles, boolean fulltextIndexLinkedFiles, Path workingDirectory, boolean createBackup, Path backupDirectory, boolean confirmDeleteLinkedFile, boolean moveToTrash, boolean adjustFileLinksOnTransfer, boolean copyLinkedFilesOnTransfer, boolean moveFilesOnTransferProperty, boolean shouldKeepDownloadUrl, Path lastUsedDirectory, boolean openFileExplorerInFileDirectory, boolean openFileExplorerInLastUsedDirectory)

Method Summary

Modifier and TypeMethod and Description
public BooleanProperty
public BooleanProperty
public ObjectProperty<Path>
public boolean
public void
confirmDeleteLinkedFile(boolean confirmLinkedFileDelete)

public BooleanProperty
public BooleanProperty
public BooleanProperty
public BooleanProperty
public StringProperty
public StringProperty
public BooleanProperty
public Path
public static FilePreferences
public String
public String
public Path
public Optional<Path>
public String
public Path
public ObjectProperty<Path>
public ObjectProperty<@Nullable Path>
public BooleanProperty
public boolean
public void
moveToTrash(boolean moveToTrash)

public BooleanProperty
public BooleanProperty
public BooleanProperty
public void
setAdjustFileLinksOnTransfer(boolean adjustFileLinksOnTransfer)

public void
setAutoRenameFilesOnChange(boolean autoRenameFilesOnChange)

public void
public void
setCopyLinkedFilesOnTransfer(boolean copyLinkedFilesOnTransfer)

public void
setCreateBackup(boolean createBackup)

public void
setDownloadLinkedFiles(boolean shouldDownloadLinkedFiles)

public void
setFileDirectoryPattern(String fileDirectoryPattern)

public void
setFileNamePattern(String fileNamePattern)

public void
setFulltextIndexLinkedFiles(boolean shouldFulltextIndexLinkedFiles)

public void
setKeepDownloadUrl(boolean shouldKeepDownloadUrl)

public void
setLastUsedDirectory(Path lastUsedDirectory)

public void
setMainFileDirectory(@Nullable Path mainFileDirectory)

public void
setMoveLinkedFilesOnTransfer(boolean moveLinkedFilesOnTransfer)

public void
public void
public void
setStoreFilesRelativeToBibFile(boolean shouldStoreFilesRelativeToBibFile)

public void
setWorkingDirectory(Path workingDirectory)

public boolean
public boolean
public boolean
public boolean
public boolean
public boolean
public boolean
public BooleanProperty
public boolean
public boolean
public boolean
public boolean
public BooleanProperty
public ObjectProperty<Path>
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

adjustFileLinksOnTransferback to summary
private final BooleanProperty adjustFileLinksOnTransfer
autoRenameFilesOnChangeback to summary
private final BooleanProperty autoRenameFilesOnChange
backupDirectoryback to summary
private final ObjectProperty<Path> backupDirectory
confirmDeleteLinkedFileback to summary
private final BooleanProperty confirmDeleteLinkedFile
copyLinkedFilesOnTransferback to summary
private final BooleanProperty copyLinkedFilesOnTransfer
createBackupback to summary
private final BooleanProperty createBackup
DEFAULT_FILENAME_PATTERNSback to summary
public static final String[] DEFAULT_FILENAME_PATTERNS
downloadLinkedFilesback to summary
private final BooleanProperty downloadLinkedFiles
fileDirectoryPatternback to summary
private final StringProperty fileDirectoryPattern
fileNamePatternback to summary
private final StringProperty fileNamePattern
fulltextIndexLinkedFilesback to summary
private final BooleanProperty fulltextIndexLinkedFiles
lastUsedDirectoryback to summary
private final ObjectProperty<Path> lastUsedDirectory
mainFileDirectoryback to summary
private final ObjectProperty<@Nullable Path> mainFileDirectory
moveLinkedFilesOnTransferback to summary
private final BooleanProperty moveLinkedFilesOnTransfer
moveToTrashback to summary
private final BooleanProperty moveToTrash
openFileExplorerInFileDirectoryback to summary
private final BooleanProperty openFileExplorerInFileDirectory
openFileExplorerInLastUsedDirectoryback to summary
private final BooleanProperty openFileExplorerInLastUsedDirectory
shouldKeepDownloadUrlback to summary
private final BooleanProperty shouldKeepDownloadUrl
storeFilesRelativeToBibFileback to summary
private final BooleanProperty storeFilesRelativeToBibFile
userAndHostback to summary
private final SimpleObjectProperty<UserHostInfo> userAndHost
workingDirectoryback to summary
private final ObjectProperty<Path> workingDirectory

Constructor Detail

FilePreferencesback to summary
private FilePreferences()
FilePreferencesback to summary
public FilePreferences(ReadOnlyObjectProperty<UserHostInfo> userAndHost, @Nullable Path mainFileDirectory, boolean storeFilesRelativeToBibFile, boolean autoRenameFilesOnChange, String fileNamePattern, String fileDirectoryPattern, boolean downloadLinkedFiles, boolean fulltextIndexLinkedFiles, Path workingDirectory, boolean createBackup, Path backupDirectory, boolean confirmDeleteLinkedFile, boolean moveToTrash, boolean adjustFileLinksOnTransfer, boolean copyLinkedFilesOnTransfer, boolean moveFilesOnTransferProperty, boolean shouldKeepDownloadUrl, Path lastUsedDirectory, boolean openFileExplorerInFileDirectory, boolean openFileExplorerInLastUsedDirectory)

Method Detail

adjustFileLinksOnTransferPropertyback to summary
public BooleanProperty adjustFileLinksOnTransferProperty()
autoRenameFilesOnChangePropertyback to summary
public BooleanProperty autoRenameFilesOnChangeProperty()
backupDirectoryPropertyback to summary
public ObjectProperty<Path> backupDirectoryProperty()
confirmDeleteLinkedFileback to summary
public boolean confirmDeleteLinkedFile()
confirmDeleteLinkedFileback to summary
public void confirmDeleteLinkedFile(boolean confirmLinkedFileDelete)
confirmDeleteLinkedFilePropertyback to summary
public BooleanProperty confirmDeleteLinkedFileProperty()
copyLinkedFilesOnTransferPropertyback to summary
public BooleanProperty copyLinkedFilesOnTransferProperty()
createBackupPropertyback to summary
public BooleanProperty createBackupProperty()
downloadLinkedFilesPropertyback to summary
public BooleanProperty downloadLinkedFilesProperty()
fileDirectoryPatternPropertyback to summary
public StringProperty fileDirectoryPatternProperty()
fileNamePatternPropertyback to summary
public StringProperty fileNamePatternProperty()
fulltextIndexLinkedFilesPropertyback to summary
public BooleanProperty fulltextIndexLinkedFilesProperty()
getBackupDirectoryback to summary
public Path getBackupDirectory()
getDefaultback to summary
public static FilePreferences getDefault()
getFileDirectoryPatternback to summary
public String getFileDirectoryPattern()
getFileNamePatternback to summary
public String getFileNamePattern()
getLastUsedDirectoryback to summary
public Path getLastUsedDirectory()
getMainFileDirectoryback to summary
public Optional<Path> getMainFileDirectory()
getUserAndHostback to summary
public String getUserAndHost()
getWorkingDirectoryback to summary
public Path getWorkingDirectory()
lastUsedDirectoryPropertyback to summary
public ObjectProperty<Path> lastUsedDirectoryProperty()
mainFileDirectoryPropertyback to summary
public ObjectProperty<@Nullable Path> mainFileDirectoryProperty()
moveLinkedFilesOnTransferPropertyPropertyback to summary
public BooleanProperty moveLinkedFilesOnTransferPropertyProperty()
moveToTrashback to summary
public boolean moveToTrash()
moveToTrashback to summary
public void moveToTrash(boolean moveToTrash)
moveToTrashPropertyback to summary
public BooleanProperty moveToTrashProperty()
openFileExplorerInFileDirectoryPropertyback to summary
public BooleanProperty openFileExplorerInFileDirectoryProperty()
openFileExplorerInLastUsedDirectoryPropertyback to summary
public BooleanProperty openFileExplorerInLastUsedDirectoryProperty()
setAdjustFileLinksOnTransferback to summary
public void setAdjustFileLinksOnTransfer(boolean adjustFileLinksOnTransfer)
setAutoRenameFilesOnChangeback to summary
public void setAutoRenameFilesOnChange(boolean autoRenameFilesOnChange)
setBackupDirectoryback to summary
public void setBackupDirectory(Path backupPath)
setCopyLinkedFilesOnTransferback to summary
public void setCopyLinkedFilesOnTransfer(boolean copyLinkedFilesOnTransfer)
setCreateBackupback to summary
public void setCreateBackup(boolean createBackup)
setDownloadLinkedFilesback to summary
public void setDownloadLinkedFiles(boolean shouldDownloadLinkedFiles)
setFileDirectoryPatternback to summary
public void setFileDirectoryPattern(String fileDirectoryPattern)
setFileNamePatternback to summary
public void setFileNamePattern(String fileNamePattern)
setFulltextIndexLinkedFilesback to summary
public void setFulltextIndexLinkedFiles(boolean shouldFulltextIndexLinkedFiles)
setKeepDownloadUrlback to summary
public void setKeepDownloadUrl(boolean shouldKeepDownloadUrl)
setLastUsedDirectoryback to summary
public void setLastUsedDirectory(Path lastUsedDirectory)
setMainFileDirectoryback to summary
public void setMainFileDirectory(@Nullable Path mainFileDirectory)
setMoveLinkedFilesOnTransferback to summary
public void setMoveLinkedFilesOnTransfer(boolean moveLinkedFilesOnTransfer)
setOpenFileExplorerInFileDirectoryback to summary
public void setOpenFileExplorerInFileDirectory(boolean value)
setOpenFileExplorerInLastUsedDirectoryback to summary
public void setOpenFileExplorerInLastUsedDirectory(boolean value)
setStoreFilesRelativeToBibFileback to summary
public void setStoreFilesRelativeToBibFile(boolean shouldStoreFilesRelativeToBibFile)
setWorkingDirectoryback to summary
public void setWorkingDirectory(Path workingDirectory)
shouldAdjustFileLinksOnTransferback to summary
public boolean shouldAdjustFileLinksOnTransfer()
shouldAutoRenameFilesOnChangeback to summary
public boolean shouldAutoRenameFilesOnChange()
shouldCopyLinkedFilesOnTransferback to summary
public boolean shouldCopyLinkedFilesOnTransfer()
shouldCreateBackupback to summary
public boolean shouldCreateBackup()
shouldDownloadLinkedFilesback to summary
public boolean shouldDownloadLinkedFiles()
shouldFulltextIndexLinkedFilesback to summary
public boolean shouldFulltextIndexLinkedFiles()
shouldKeepDownloadUrlback to summary
public boolean shouldKeepDownloadUrl()
shouldKeepDownloadUrlPropertyback to summary
public BooleanProperty shouldKeepDownloadUrlProperty()
shouldMoveLinkedFilesOnTransferback to summary
public boolean shouldMoveLinkedFilesOnTransfer()
shouldOpenFileExplorerInFileDirectoryback to summary
public boolean shouldOpenFileExplorerInFileDirectory()
shouldOpenFileExplorerInLastUsedDirectoryback to summary
public boolean shouldOpenFileExplorerInLastUsedDirectory()
shouldStoreFilesRelativeToBibFileback to summary
public boolean shouldStoreFilesRelativeToBibFile()
storeFilesRelativeToBibFilePropertyback to summary
public BooleanProperty storeFilesRelativeToBibFileProperty()
workingDirectoryPropertyback to summary
public ObjectProperty<Path> workingDirectoryProperty()