JabRef 6.0-beta.1 · org.jabref.gui.LibraryTab · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private class	LibraryTab.GroupTreeListener
private class	LibraryTab.IndexUpdateListener
pack-priv static class	LibraryTab.SharedDatabaseLoadingCallbacks
pack-priv static class	LibraryTab.SharedDatabaseLoadingTask

Modifier and Type	Field and Description
private final AiService	aiService
private FileAnnotationCache	annotationCache
private Runnable	autoCompleterChangedListener
private AutoRenameFileOnEntryChange	autoRenameFileOnEntryChange
private boolean	backOrForwardNavigationActionTriggered
private BibDatabaseContext	bibDatabaseContext
private final BooleanProperty	canGoBackProperty
private final BooleanProperty	canGoForwardProperty
private final BooleanProperty	changedProperty
private Optional<DatabaseChangeMonitor>	changeMonitor
private final ClipBoardManager	clipBoardManager
private CoarseChangeFilter	coarseChangeFilter
private org.jabref.logic.util.BackgroundTask<?>	dataLoadingTask
private final DialogService	dialogService
private com.tobiasdiez.easybind.Subscription	dividerPositionSubscription
private final BibEntryTypesManager	entryTypesManager
private final FileUpdateMonitor	fileUpdateMonitor
private final GitHandlerRegistry	gitHandlerRegistry
private ImportHandler	importHandler
private final JournalAbbreviationRepository	journalAbbreviationRepository
private final SimpleBooleanProperty	loading
private static final Logger	LOGGER
private MainTable	mainTable
private final NavigationHistory	navigationHistory
private final GuiPreferences	preferences
private final IntegerProperty	resultSize
private boolean	saving
private PersonNameSuggestionProvider	searchAutoCompleter
private SearchContext	searchContext
private final org.jabref.logic.util.OptionalObjectProperty<SearchQuery>	searchQueryProperty
private ListProperty<GroupTreeNode>	selectedGroupsProperty
private final StateManager	stateManager
private SuggestionProviders	suggestionProviders
private final LibraryTabContainer	tabContainer
private MainTableDataModel	tableModel
private final TaskExecutor	taskExecutor

Access	Constructor and Description
private	LibraryTab(@NonNull BibDatabaseContext bibDatabaseContext, @NonNull LibraryTabContainer tabContainer, @NonNull DialogService dialogService, AiService aiService, @NonNull GuiPreferences preferences, @NonNull StateManager stateManager, FileUpdateMonitor fileUpdateMonitor, BibEntryTypesManager entryTypesManager, ClipBoardManager clipBoardManager, TaskExecutor taskExecutor, GitHandlerRegistry gitHandlerRegistry, boolean Indicates whether the database context is a dummy. A dummy context is used to display a progress indicator while parsing the database. isDummyContext) 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()`.

Method Summary

Modifier and Type	Method and Description
private static void	addChangedInformation(StringBuilder text)
private static void	addModeInfo(StringBuilder text, BibDatabaseContext bibDatabaseContext)
private static void	addSharedDbInformation(StringBuilder text, BibDatabaseContext bibDatabaseContext)
public void	back()
public boolean	canGoBack()
public BooleanProperty	canGoBackProperty()
public boolean	canGoForward()
public BooleanProperty	canGoForwardProperty()
public void	clearAndSelect(@NonNull BibEntry bibEntry) This method selects the given entry, and scrolls it into view in the table.
public void	clearAndSelect(final List<BibEntry> bibEntries)
public void	closeSearchContext()
private static void	closeSharedDatabase(BibDatabaseContext bibDatabaseContext)
private boolean	Returns: `true` if the user chooses to close the database confirmClose() Ask if the user really wants to close the given database.
public void	copyEntry()
public static LibraryTab	createLibraryTab(org.jabref.logic.util.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, ClipBoardManager clipBoardManager, TaskExecutor taskExecutor, GitHandlerRegistry gitHandlerRegistry) Creates a new library tab.
public static LibraryTab	createLibraryTab(Callable<BibDatabaseContext> connectionTask, BibDatabaseContext dummyContext, DialogService dialogService, AiService aiService, GuiPreferences preferences, StateManager stateManager, LibraryTabContainer tabContainer, FileUpdateMonitor fileUpdateMonitor, BibEntryTypesManager entryTypesManager, ClipBoardManager clipBoardManager, TaskExecutor taskExecutor, GitHandlerRegistry gitHandlerRegistry, BiConsumer<LibraryTab, BibDatabaseContext> onSuccess, Consumer<Exception> onFailure) Creates a shared-library tab that displays the main table's loading indicator until `connectionTask` has connected.
public static LibraryTab	createLibraryTab(@NonNull BibDatabaseContext databaseContext, LibraryTabContainer tabContainer, DialogService dialogService, AiService aiService, GuiPreferences preferences, StateManager stateManager, FileUpdateMonitor fileUpdateMonitor, BibEntryTypesManager entryTypesManager, ClipBoardManager clipBoardManager, TaskExecutor taskExecutor, GitHandlerRegistry gitHandlerRegistry)
private void	createMainTable()
public void	createSearchContext()
public void	cutEntry() Copies the selection to the clipboard, then removes it from the library.
public void	deleteEntry() Removes the selected entries and files linked to selected entries from the database
public void	deleteEntry(BibEntry entry)
private int	doCopyEntry(TransferMode transferMode, 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(BibDatabaseContext sourceBibDatabaseContext, List<BibEntry> originalEntries, List<BibEntry> entriesToAdd, TransferMode mode)
public void	forward()
public FileAnnotationCache	getAnnotationCache()
public SuggestionProvider<Author>	getAutoCompleter()
public BibDatabaseContext	getBibDatabaseContext()
public BibDatabase	getDatabase() Put an asterisk behind the filename to indicate the database has changed.
public ObservableBooleanValue	getLoading()
public MainTable	getMainTable()
public SearchContext	getSearchContext()
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 UndoManager	getUndoManager() The journal to record a change to this library on.
private int	getUntitledLibraryNumber() Returns an index for a new untitled library to generate names like "untitled (1)", "untitled (2)", etc.
private List<BibEntry>	handleNonBibTeXStringData(String data)
private void	initializeComponentsAndListeners(boolean isDummyContext)
public void	insertEntries(final List<BibEntry> the list of entries to insert; must not be empty entries) Inserts the given entries into the database and updates the UI accordingly.
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()
private GuiUndoManager	journal()
public void	listen(BibDatabaseContextChangedEvent event) Marks the changes the journal does not know about, so that `changedProperty` can derive the rest from it.
private BibDatabaseContext	loadSavedFile() Parses the file on disk; its TeX groups must not register with the shared file monitor because the snapshot is discarded after the diff.
private void	navigateToEntry(BibEntry entry)
private void	newEntryShowing(BibEntry entry)
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	onDatabaseLoadingSucceed(ParserResult result)
private BibDatabaseContext	parseSavedFile(Path path)
public void	pasteEntry()
public void	registerUndoableChanges(List<FieldChange> changes)
public boolean	requestClose()
public void	resetChangedProperties()
public void	resetChangedProperties(@Nullable FileSnapshot the on-disk state the library matches, as reported by the writer that committed it; `null` to determine it from the file (e.g. after merging all external changes) diskState) All call sites mean "in-memory library now matches the disk", so file events for that state need no scan.
public void	resetChangeMonitor()
public IntegerProperty	resultSizeProperty()
public void	resumeChangeMonitor() Resuming also scans for external changes that arrived while the monitor was suspended, e.g. a concurrent write that aborted the suspended save — the standard external-changes review flow is offered for them.
public org.jabref.logic.util.OptionalObjectProperty<SearchQuery>	searchQueryProperty()
public ListProperty<GroupTreeNode>	selectedGroupsProperty()
public void	selectNextEntry()
public void	selectPreviousEntry()
public void	setAutoCompleterChangedListener(@NonNull Runnable listener)
private void	setDatabaseContext(@NonNull BibDatabaseContext bibDatabaseContext)
private void	setDataLoadingTask(org.jabref.logic.util.BackgroundTask<?> dataLoadingTask)
public void	setSaving(boolean saving)
private void	setupAutoCompletion() Set up autocompletion for this database
public void	setupMainPanel()
public void	showAndEdit(@NonNull BibEntry entry)
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
private void	showDiffDialog(BibDatabaseContext savedDatabase)
private void	showDiffError(Exception exception)
private void	showDiffToSavedFile() Shows the unsaved in-memory changes compared to the file on disk (or to an empty library if never saved).
public void	startDataLoadingTask() Starts a loading task after its tab has been added to the tab container.
public void	suspendChangeMonitor()
pack-priv static IconTheme.JabRefIcons	tabIcon(DatabaseLocation location, BibDatabaseMode mode)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	updateNavigationState() Updates the StateManager with current navigation state Only update if this is the active tab
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

public Class LibraryTab

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary