JabRef 6.0-snapshot-2025-03-20 · org.jabref.gui.LibraryTab

Modifier and Type	Class and Description
public static class	LibraryTab.DatabaseNotification
private class	LibraryTab.EntriesRemovedListener
private class	LibraryTab.GroupTreeListener
private class	LibraryTab.IndexUpdateListener
private static enum	LibraryTab.PanelMode Defines the different modes that the tab can operate in

Modifier and Type	Field and Description
private final AiService	aiService
private FileAnnotationCache	annotationCache
private BibDatabaseContext	bibDatabaseContext
private final BooleanProperty	changedProperty
private Optional<DatabaseChangeMonitor>	changeMonitor
private final ClipBoardManager	clipBoardManager
private LibraryTab.DatabaseNotification	databaseNotificationPane
private BackgroundTask<ParserResult>	dataLoadingTask
private final DialogService	dialogService
private final DirectoryMonitorManager	directoryMonitorManager
private com.tobiasdiez.easybind.Subscription	dividerPositionSubscription
private EntryEditor	entryEditor
private final BibEntryTypesManager	entryTypesManager
private final FileUpdateMonitor	fileUpdateMonitor
private ImportHandler	importHandler
private IndexManager	indexManager
private final SimpleBooleanProperty	loading
private static final Logger	LOGGER
private MainTable	mainTable
private LibraryTab.PanelMode	mode
private final BooleanProperty	nonUndoableChangeProperty
private final GuiPreferences	preferences
private final IntegerProperty	resultSize
private boolean	saving
private PersonNameSuggestionProvider	searchAutoCompleter
private final OptionalObjectProperty<SearchQuery>	searchQueryProperty
private ListProperty<GroupTreeNode>	selectedGroupsProperty
private BibEntry	showing
private SplitPane	splitPane
private final StateManager	stateManager
private SuggestionProviders	suggestionProviders
private final LibraryTabContainer	tabContainer
private MainTableDataModel	tableModel
private final TaskExecutor	taskExecutor
private final CountingUndoManager	undoManager

Access	Constructor and Description
private	LibraryTab(BibDatabaseContext bibDatabaseContext, LibraryTabContainer tabContainer, DialogService dialogService, AiService aiService, GuiPreferences preferences, StateManager stateManager, FileUpdateMonitor fileUpdateMonitor, BibEntryTypesManager entryTypesManager, CountingUndoManager undoManager, ClipBoardManager clipBoardManager, TaskExecutor taskExecutor, boolean Indicates whether the database context is a dummy. A dummy context is used to display a progress indicator while parsing the database. If the context is a dummy, the Lucene index should not be created, as both the dummy context and the actual context share the same index path `BibDatabaseContext#getFulltextIndexPath()`. If the index is created for the dummy context, the actual context will not be able to open the index until it is closed by the dummy context. Closing the index takes time and will slow down opening the library. isDummyContext)

Method Summary

Modifier and Type	Method and Description
private static void	addChangedInformation(StringBuilder text, String fileName)
private static void	addModeInfo(StringBuilder text, BibDatabaseContext bibDatabaseContext)
private static void	addSharedDbInformation(StringBuilder text, BibDatabaseContext bibDatabaseContext)
public void	clearAndSelect(final BibEntry bibEntry) This method selects the given entry, and scrolls it into view in the table.
public void	closeBottomPane()
public void	closeIndexManger()
private boolean	Returns: `true` if the user choose to close the database confirmClose() Ask if the user really wants to close the given database.
public void	copyEntry()
private EntryEditor	createEntryEditor()
public void	createIndexManager()
public static LibraryTab	createLibraryTab(BackgroundTask<ParserResult> The task to execute to load the data asynchronously. dataLoadingTask, Path the path to the file (loaded by the dataLoadingTask) file, DialogService dialogService, AiService aiService, GuiPreferences preferences, StateManager stateManager, LibraryTabContainer tabContainer, FileUpdateMonitor fileUpdateMonitor, BibEntryTypesManager entryTypesManager, CountingUndoManager undoManager, ClipBoardManager clipBoardManager, TaskExecutor taskExecutor) Creates a new library tab.
public static LibraryTab	createLibraryTab(BibDatabaseContext databaseContext, LibraryTabContainer tabContainer, DialogService dialogService, AiService aiService, GuiPreferences preferences, StateManager stateManager, FileUpdateMonitor fileUpdateMonitor, BibEntryTypesManager entryTypesManager, UndoManager undoManager, ClipBoardManager clipBoardManager, TaskExecutor taskExecutor)
private Node	createLoadingAnimationLayout() The layout to display in the tab when it is loading
private void	createMainTable()
public void	cutEntry()
public void	deleteEntry() Removes the selected entries and files linked to selected entries from the database
public void	deleteEntry(BibEntry entry)
private int	doCopyEntry(List<BibEntry> selectedEntries)
private int	doDeleteEntry(StandardActions If DELETE_ENTRY the user will get asked if he really wants to delete the entries, and it will be localized as "deleted". If true the action will be localized as "cut" mode, List<BibEntry> entries) Removes the selected entries and files linked to selected entries from the database
public void	dropEntry(List<BibEntry> entriesToAdd)
public void	editEntryAndFocusField(BibEntry entry, Field field)
private void	ensureNotShowingBottomPanel(List<BibEntry> entriesToCheck) Closes the entry editor if it is showing any of the given entries.
public void	entryEditorClosing() This method is called from an EntryEditor when it should be closed.
public FileAnnotationCache	getAnnotationCache()
public SuggestionProvider<Author>	getAutoCompleter()
public BibDatabaseContext	getBibDatabaseContext()
public BibDatabase	getDatabase()
public DirectoryMonitorManager	getDirectoryMonitorManager()
public EntryEditor	getEntryEditor()
public IndexManager	getIndexManager()
public LibraryTabContainer	getLibraryTabContainer()
public ObservableBooleanValue	getLoading()
public MainTable	getMainTable()
public LibraryTab.DatabaseNotification	getNotificationPane()
public List<BibEntry>	Returns: A list containing the selected entries. Is never null. getSelectedEntries() Get an array containing the currently selected entries.
public SuggestionProviders	getSuggestionProviders() Returns a collection of suggestion providers, which are populated from the current library.
public CountingUndoManager	getUndoManager()
private List<BibEntry>	handleNonBibTeXStringData(String data)
private void	initializeComponentsAndListeners(boolean isDummyContext)
public void	insertEntries(final List<BibEntry> entries)
public void	insertEntry(final BibEntry bibEntry)
public void	installAutosaveManagerAndBackupManager()
private boolean	isDatabaseReadyForAutoSave(BibDatabaseContext context)
private boolean	isDatabaseReadyForBackup(BibDatabaseContext context)
public boolean	isModified()
public boolean	isSaving()
public void	listen(BibDatabaseContextChangedEvent event)
public void	markBaseChanged()
public synchronized void	markChangedOrUnChanged() Put an asterisk behind the filename to indicate the database has changed.
public void	markNonUndoableBaseChanged()
private void	onClosed(Event event) Perform necessary cleanup when this Library is closed.
private void	onCloseRequest(Event event)
private void	onDatabaseLoadingFailed(Exception ex)
private void	onDatabaseLoadingStarted()
private void	onDatabaseLoadingSucceed(ParserResult result)
public void	pasteEntry()
public void	registerUndoableChanges(List<FieldChange> changes)
public boolean	requestClose()
public void	resetChangedProperties()
public void	resetChangeMonitor()
public IntegerProperty	resultSizeProperty()
private void	saveDividerLocation(Number position) Depending on whether a preview or an entry editor is showing, save the current divider location in the correct preference setting.
public OptionalObjectProperty<SearchQuery>	searchQueryProperty()
public ListProperty<GroupTreeNode>	selectedGroupsProperty()
public void	selectNextEntry()
public void	selectPreviousEntry()
private void	setDatabaseContext(BibDatabaseContext bibDatabaseContext)
private void	setDataLoadingTask(BackgroundTask<ParserResult> dataLoadingTask)
public void	setSaving(boolean saving)
private void	setupAutoCompletion() Set up autocompletion for this database
public void	setupMainPanel()
public void	showAndEdit(BibEntry The entry to edit. entry) Sets the entry editor as the bottom component in the split pane.
private boolean	Returns: true if user confirm to delete entry showDeleteConfirmationDialog(int number of entries user is selecting numberOfEntries) Initializes a pop-up dialog box to confirm whether the user wants to delete the selected entry Keep track of user preference: if the user prefers not to ask before deleting, delete the selected entry without displaying the dialog box
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	updateTabTitle(boolean isChanged) Sets the title of the tab modification-asterisk filename – path-fragment The modification-asterisk () is shown if the file was modified since last save (path-fragment is only shown if filename is not (globally) unique) Example: jabref-authors.bib – testbib

Field Detail

aiService	back to summary
private final AiService aiService

annotationCache	back to summary
private FileAnnotationCache annotationCache

bibDatabaseContext	back to summary
private BibDatabaseContext bibDatabaseContext

changedProperty	back to summary
private final BooleanProperty changedProperty

changeMonitor	back to summary
private Optional<DatabaseChangeMonitor> changeMonitor

clipBoardManager	back to summary
private final ClipBoardManager clipBoardManager

databaseNotificationPane	back to summary
private LibraryTab.DatabaseNotification databaseNotificationPane

dataLoadingTask	back to summary
private BackgroundTask<ParserResult> dataLoadingTask

dialogService	back to summary
private final DialogService dialogService

directoryMonitorManager	back to summary
private final DirectoryMonitorManager directoryMonitorManager

dividerPositionSubscription	back to summary
private com.tobiasdiez.easybind.Subscription dividerPositionSubscription Annotations @SuppressWarnings:FieldCanBeLocal

entryEditor	back to summary
private EntryEditor entryEditor

entryTypesManager	back to summary
private final BibEntryTypesManager entryTypesManager

fileUpdateMonitor	back to summary
private final FileUpdateMonitor fileUpdateMonitor

importHandler	back to summary
private ImportHandler importHandler

indexManager	back to summary
private IndexManager indexManager

loading	back to summary
private final SimpleBooleanProperty loading

LOGGER	back to summary
private static final Logger LOGGER

mainTable	back to summary
private MainTable mainTable

mode	back to summary
private LibraryTab.PanelMode mode

nonUndoableChangeProperty	back to summary
private final BooleanProperty nonUndoableChangeProperty

preferences	back to summary
private final GuiPreferences preferences

resultSize	back to summary
private final IntegerProperty resultSize

saving	back to summary
private boolean saving

searchAutoCompleter	back to summary
private PersonNameSuggestionProvider searchAutoCompleter

searchQueryProperty	back to summary
private final OptionalObjectProperty<SearchQuery> searchQueryProperty

selectedGroupsProperty	back to summary
private ListProperty<GroupTreeNode> selectedGroupsProperty

showing	back to summary
private BibEntry showing

splitPane	back to summary
private SplitPane splitPane

stateManager	back to summary
private final StateManager stateManager

suggestionProviders	back to summary
private SuggestionProviders suggestionProviders

tabContainer	back to summary
private final LibraryTabContainer tabContainer

tableModel	back to summary
private MainTableDataModel tableModel

taskExecutor	back to summary
private final TaskExecutor taskExecutor

undoManager	back to summary
private final CountingUndoManager undoManager

Constructor Detail

LibraryTab back to summary

LibraryTab	back to summary
private LibraryTab(BibDatabaseContext bibDatabaseContext, LibraryTabContainer tabContainer, DialogService dialogService, AiService aiService, GuiPreferences preferences, StateManager stateManager, FileUpdateMonitor fileUpdateMonitor, BibEntryTypesManager entryTypesManager, CountingUndoManager undoManager, ClipBoardManager clipBoardManager, TaskExecutor taskExecutor, boolean isDummyContext) Parameters isDummyContext:boolean Indicates whether the database context is a dummy. A dummy context is used to display a progress indicator while parsing the database. If the context is a dummy, the Lucene index should not be created, as both the dummy context and the actual context share the same index path `BibDatabaseContext#getFulltextIndexPath()`. If the index is created for the dummy context, the actual context will not be able to open the index until it is closed by the dummy context. Closing the index takes time and will slow down opening the library.

private LibraryTab(BibDatabaseContext bibDatabaseContext, LibraryTabContainer tabContainer, DialogService dialogService, AiService aiService, GuiPreferences preferences, StateManager stateManager, FileUpdateMonitor fileUpdateMonitor, BibEntryTypesManager entryTypesManager, CountingUndoManager undoManager, ClipBoardManager clipBoardManager, TaskExecutor taskExecutor, boolean isDummyContext)

Parameters

isDummyContext:boolean: Indicates whether the database context is a dummy. A dummy context is used to display a progress indicator while parsing the database. If the context is a dummy, the Lucene index should not be created, as both the dummy context and the actual context share the same index path BibDatabaseContext#getFulltextIndexPath(). If the index is created for the dummy context, the actual context will not be able to open the index until it is closed by the dummy context. Closing the index takes time and will slow down opening the library.

Method Detail

addChangedInformation	back to summary
private static void addChangedInformation(StringBuilder text, String fileName)

addModeInfo	back to summary
private static void addModeInfo(StringBuilder text, BibDatabaseContext bibDatabaseContext)

addSharedDbInformation	back to summary
private static void addSharedDbInformation(StringBuilder text, BibDatabaseContext bibDatabaseContext)

clearAndSelect	back to summary
public void clearAndSelect(final BibEntry bibEntry) This method selects the given entry, and scrolls it into view in the table. If an entryEditor is shown, it is given focus afterwards.

closeBottomPane	back to summary
public void closeBottomPane()

closeIndexManger	back to summary
public void closeIndexManger()

confirmClose back to summary

confirmClose	back to summary
private boolean confirmClose() Ask if the user really wants to close the given database. Offers to save or discard the changes -- or return to the library Returns:boolean `true` if the user choose to close the database

private boolean confirmClose()

Ask if the user really wants to close the given database. Offers to save or discard the changes -- or return to the library

Returns:boolean: true if the user choose to close the database

copyEntry	back to summary
public void copyEntry()

createEntryEditor	back to summary
private EntryEditor createEntryEditor()

createIndexManager	back to summary
public void createIndexManager()

createLibraryTab back to summary

public static LibraryTab createLibraryTab(BackgroundTask<ParserResult> dataLoadingTask, Path file, DialogService dialogService, AiService aiService, GuiPreferences preferences, StateManager stateManager, LibraryTabContainer tabContainer, FileUpdateMonitor fileUpdateMonitor, BibEntryTypesManager entryTypesManager, CountingUndoManager undoManager, ClipBoardManager clipBoardManager, TaskExecutor taskExecutor)

Creates a new library tab. Contents are loaded by the dataLoadingTask. Most of the other parameters are required by resetChangeMonitor().

Parameters

dataLoadingTask:BackgroundTask<ParserResult>: The task to execute to load the data asynchronously.
file:Path: the path to the file (loaded by the dataLoadingTask)

createLibraryTab	back to summary
public static LibraryTab createLibraryTab(BibDatabaseContext databaseContext, LibraryTabContainer tabContainer, DialogService dialogService, AiService aiService, GuiPreferences preferences, StateManager stateManager, FileUpdateMonitor fileUpdateMonitor, BibEntryTypesManager entryTypesManager, UndoManager undoManager, ClipBoardManager clipBoardManager, TaskExecutor taskExecutor)

createLoadingAnimationLayout	back to summary
private Node createLoadingAnimationLayout() The layout to display in the tab when it is loading

createMainTable	back to summary
private void createMainTable()

cutEntry	back to summary
public void cutEntry()

deleteEntry	back to summary
public void deleteEntry() Removes the selected entries and files linked to selected entries from the database

deleteEntry	back to summary
public void deleteEntry(BibEntry entry)

doCopyEntry	back to summary
private int doCopyEntry(List<BibEntry> selectedEntries)

doDeleteEntry

back to summary

private int doDeleteEntry(StandardActions mode, List<BibEntry> entries)

Removes the selected entries and files linked to selected entries from the database

Parameters

mode:StandardActions: If DELETE_ENTRY the user will get asked if he really wants to delete the entries, and it will be localized as "deleted". If true the action will be localized as "cut"

dropEntry	back to summary
public void dropEntry(List<BibEntry> entriesToAdd)

editEntryAndFocusField	back to summary
public void editEntryAndFocusField(BibEntry entry, Field field)

ensureNotShowingBottomPanel	back to summary
private void ensureNotShowingBottomPanel(List<BibEntry> entriesToCheck) Closes the entry editor if it is showing any of the given entries.

entryEditorClosing	back to summary
public void entryEditorClosing() This method is called from an EntryEditor when it should be closed. We relay to the selection listener, which takes care of the rest.

getAnnotationCache	back to summary
public FileAnnotationCache getAnnotationCache()

getAutoCompleter	back to summary
public SuggestionProvider<Author> getAutoCompleter()

getBibDatabaseContext	back to summary
public BibDatabaseContext getBibDatabaseContext()

getDatabase	back to summary
public BibDatabase getDatabase()

getDirectoryMonitorManager	back to summary
public DirectoryMonitorManager getDirectoryMonitorManager()

getEntryEditor	back to summary
public EntryEditor getEntryEditor()

getIndexManager	back to summary
public IndexManager getIndexManager()

getLibraryTabContainer	back to summary
public LibraryTabContainer getLibraryTabContainer()

getLoading	back to summary
public ObservableBooleanValue getLoading()

getMainTable	back to summary
public MainTable getMainTable()

getNotificationPane	back to summary
public LibraryTab.DatabaseNotification getNotificationPane()

getSelectedEntries

back to summary

public List<BibEntry> getSelectedEntries()

Get an array containing the currently selected entries. The array is stable and not changed if the selection changes

Returns:List<BibEntry>: A list containing the selected entries. Is never null.

getSuggestionProviders	back to summary
public SuggestionProviders getSuggestionProviders() Returns a collection of suggestion providers, which are populated from the current library.

getUndoManager	back to summary
public CountingUndoManager getUndoManager()

handleNonBibTeXStringData	back to summary
private List<BibEntry> handleNonBibTeXStringData(String data)

initializeComponentsAndListeners	back to summary
private void initializeComponentsAndListeners(boolean isDummyContext)

insertEntries	back to summary
public void insertEntries(final List<BibEntry> entries)

insertEntry	back to summary
public void insertEntry(final BibEntry bibEntry)

installAutosaveManagerAndBackupManager	back to summary
public void installAutosaveManagerAndBackupManager()

isDatabaseReadyForAutoSave	back to summary
private boolean isDatabaseReadyForAutoSave(BibDatabaseContext context)

isDatabaseReadyForBackup	back to summary
private boolean isDatabaseReadyForBackup(BibDatabaseContext context)

isModified	back to summary
public boolean isModified()

isSaving	back to summary
public boolean isSaving()

listen	back to summary
public void listen(BibDatabaseContextChangedEvent event) Annotations @Subscribe

markBaseChanged	back to summary
public void markBaseChanged()

markChangedOrUnChanged	back to summary
public synchronized void markChangedOrUnChanged() Put an asterisk behind the filename to indicate the database has changed.

markNonUndoableBaseChanged	back to summary
public void markNonUndoableBaseChanged()

onClosed	back to summary
private void onClosed(Event event) Perform necessary cleanup when this Library is closed.

onCloseRequest	back to summary
private void onCloseRequest(Event event)

onDatabaseLoadingFailed	back to summary
private void onDatabaseLoadingFailed(Exception ex)

onDatabaseLoadingStarted	back to summary
private void onDatabaseLoadingStarted()

onDatabaseLoadingSucceed	back to summary
private void onDatabaseLoadingSucceed(ParserResult result)

pasteEntry	back to summary
public void pasteEntry()

registerUndoableChanges	back to summary
public void registerUndoableChanges(List<FieldChange> changes)

requestClose	back to summary
public boolean requestClose()

resetChangedProperties	back to summary
public void resetChangedProperties()

resetChangeMonitor	back to summary
public void resetChangeMonitor()

resultSizeProperty	back to summary
public IntegerProperty resultSizeProperty()

saveDividerLocation	back to summary
private void saveDividerLocation(Number position) Depending on whether a preview or an entry editor is showing, save the current divider location in the correct preference setting.

searchQueryProperty	back to summary
public OptionalObjectProperty<SearchQuery> searchQueryProperty()

selectedGroupsProperty	back to summary
public ListProperty<GroupTreeNode> selectedGroupsProperty()

selectNextEntry	back to summary
public void selectNextEntry()

selectPreviousEntry	back to summary
public void selectPreviousEntry()

setDatabaseContext	back to summary
private void setDatabaseContext(BibDatabaseContext bibDatabaseContext)

setDataLoadingTask	back to summary
private void setDataLoadingTask(BackgroundTask<ParserResult> dataLoadingTask)

setSaving	back to summary
public void setSaving(boolean saving)

setupAutoCompletion	back to summary
private void setupAutoCompletion() Set up autocompletion for this database

setupMainPanel	back to summary
public void setupMainPanel()

showAndEdit back to summary

public void showAndEdit(BibEntry entry)

Sets the entry editor as the bottom component in the split pane. If an entry editor already was shown, makes sure that the divider doesn't move. Updates the mode to PanelMode#MAIN_TABLE_AND_ENTRY_EDITOR. Then shows the given entry. Additionally, selects the entry in the main table - so that the selected entry in the main table always corresponds to the edited entry.

Parameters

entry:BibEntry: The entry to edit.

showDeleteConfirmationDialog

back to summary

private boolean showDeleteConfirmationDialog(int numberOfEntries)

Initializes a pop-up dialog box to confirm whether the user wants to delete the selected entry Keep track of user preference: if the user prefers not to ask before deleting, delete the selected entry without displaying the dialog box

Parameters

numberOfEntries:int: number of entries user is selecting

Returns:boolean

true if user confirm to delete entry

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

updateTabTitle

back to summary

public void updateTabTitle(boolean isChanged)

Sets the title of the tab modification-asterisk filename – path-fragment

The modification-asterisk (*) is shown if the file was modified since last save (path-fragment is only shown if filename is not (globally) unique)

Example: *jabref-authors.bib – testbib

Modifier and Type	Method and Description
public static LibraryTab.PanelMode	valueOf(String name)
public static LibraryTab.PanelMode[]	values()

public Class LibraryTab

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class LibraryTab.DatabaseNotification

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class LibraryTab.EntriesRemovedListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class LibraryTab.GroupTreeListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class LibraryTab.IndexUpdateListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Enum LibraryTab.PanelMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public void	listen(EntriesAddedEvent addedEntryEvent)
public void	listen(EntriesRemovedEvent removedEntriesEvent)
public void	listen(FieldChangedEvent fieldChangedEvent)

Modifier and Type	Field and Description
public static final LibraryTab.PanelMode	MAIN_TABLE
public static final LibraryTab.PanelMode	MAIN_TABLE_AND_ENTRY_EDITOR