Verified Owner
Top Inners Fields Constructors Methods
org.jabref.gui.externalfiles

public Class FileSelectionPage

extends WizardPane
Class Inheritance
Imports
java.nio.file.Files, .Path, java.util.Comparator, .List, .Map, .StringJoiner, javafx.application.Platform, javafx.beans.binding.Bindings, javafx.beans.property.BooleanProperty, .SimpleBooleanProperty, javafx.collections.FXCollections, javafx.scene.Node, javafx.scene.control.Button, .ButtonType, .CheckBox, .CheckBoxTreeItem, .ContextMenu, .Label, .ProgressIndicator, .SelectionMode, .SplitPane, .TextArea, .TitledPane, .Tooltip, .TreeItem, javafx.scene.layout.BorderPane, .HBox, .Priority, .VBox, org.jabref.gui.StateManager, org.jabref.gui.actions.ActionFactory, .SimpleCommand, .StandardActions, org.jabref.gui.documentviewer.PdfDocumentViewer, org.jabref.gui.icon.IconTheme, org.jabref.gui.util.FileNodeViewModel, .RecursiveTreeItem, .UiTaskExecutor, org.jabref.logic.importer.ImportFormatPreferences, .ParserResult, org.jabref.logic.importer.fileformat.pdf.PdfMergeMetadataImporter, org.jabref.logic.l10n.Localization, org.jabref.logic.util.BackgroundTask, .DelayTaskThrottler, .TaskExecutor, org.jabref.logic.util.io.FileUtil, org.jabref.model.entry.BibEntry, org.jabref.model.entry.field.Field, .StandardField, com.tobiasdiez.easybind.EasyBind, org.controlsfx.control.CheckTreeView, org.controlsfx.dialog.Wizard, .WizardPane, org.jspecify.annotations.Nullable, org.slf4j.Logger, .LoggerFactory

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class
FileSelectionPage.TreeContextAction

Field Summary

Modifier and TypeField and Description
private Button
collapseAllButton

private VBox
contentPane

private @Nullable org.jabref.logic.util.BackgroundTask<?>
currentMetadataTask

private CheckBox
enablePreviewCheckBox

private Button
expandAllButton

private Label
fileCountLabel

private final ImportFormatPreferences
importFormatPreferences

private final BooleanProperty
invalidProperty

private static final Logger
LOGGER

private static final List<Field>
METADATA_PRIORITIZED_FIELDS

private TextArea
metadataPreview

private boolean
nextButtonBound

private PdfDocumentViewer
pdfPreview

private static final int
PREVIEW_REFRESH_DELAY

private TitledPane
previewPane

private final DelayTaskThrottler
previewThrottler

private VBox
progressPane

private Button
selectAllButton

private Button
showPreviewButton

private SplitPane
splitPane

private final StateManager
stateManager

private final TaskExecutor
taskExecutor

private CheckTreeView<FileNodeViewModel>
unlinkedFilesList

private Button
unselectAllButton

private final UnlinkedFilesDialogViewModel
viewModel

Constructor Summary

AccessConstructor and Description
public
FileSelectionPage(StateManager stateManager, UnlinkedFilesDialogViewModel viewModel, ImportFormatPreferences importFormatPreferences, TaskExecutor taskExecutor)

Method Summary

Modifier and TypeMethod and Description
private void
cancelCurrentMetadataTask()

public void
cancelPreviewTasks()

Cancels any in-flight preview work.

private ContextMenu
createContextMenu()

private void
expandTree(TreeItem<?> item, boolean expand)

private String
formatBibEntry(BibEntry entry)

private String
formatParserResult(ParserResult result)

private void
hidePreviewPane()

impl->req~jabgui.externalfiles.unlinked-files.preview.close~1

public BooleanProperty
invalidProperty()

private boolean
isPreviewActive()

private boolean
isPreviewPaneVisible()

public void
onEnteringPage(Wizard wizard)

Overrides org.controlsfx.dialog.WizardPane.onEnteringPage.

Called on entering a page.

public void
onExitingPage(Wizard wizard)

Overrides org.controlsfx.dialog.WizardPane.onExitingPage.

Called on existing the page.

private static int
priorityIndex(Field field)

private void
refreshPreviewForCurrentSelection()

private void
setupBindings()

private void
setupUI()

private void
showPreviewDisabledState(String metadataText)

private void
showPreviewPane()

public void
shutdown()

Cancels in-flight preview work and stops the preview throttler.

private void
updateFileCount(TreeItem<FileNodeViewModel> root)

Field Detail

collapseAllButtonback to summary
private Button collapseAllButton
contentPaneback to summary
private VBox contentPane
currentMetadataTaskback to summary
private @Nullable org.jabref.logic.util.BackgroundTask<?> currentMetadataTask
enablePreviewCheckBoxback to summary
private CheckBox enablePreviewCheckBox
expandAllButtonback to summary
private Button expandAllButton
fileCountLabelback to summary
private Label fileCountLabel
importFormatPreferencesback to summary
private final ImportFormatPreferences importFormatPreferences
invalidPropertyback to summary
private final BooleanProperty invalidProperty
LOGGERback to summary
private static final Logger LOGGER
METADATA_PRIORITIZED_FIELDSback to summary
private static final List<Field> METADATA_PRIORITIZED_FIELDS
metadataPreviewback to summary
private TextArea metadataPreview
nextButtonBoundback to summary
private boolean nextButtonBound
pdfPreviewback to summary
private PdfDocumentViewer pdfPreview
PREVIEW_REFRESH_DELAYback to summary
private static final int PREVIEW_REFRESH_DELAY
previewPaneback to summary
private TitledPane previewPane
previewThrottlerback to summary
private final DelayTaskThrottler previewThrottler
progressPaneback to summary
private VBox progressPane
selectAllButtonback to summary
private Button selectAllButton
showPreviewButtonback to summary
private Button showPreviewButton
splitPaneback to summary
private SplitPane splitPane
stateManagerback to summary
private final StateManager stateManager
taskExecutorback to summary
private final TaskExecutor taskExecutor
unlinkedFilesListback to summary
private CheckTreeView<FileNodeViewModel> unlinkedFilesList
unselectAllButtonback to summary
private Button unselectAllButton
viewModelback to summary
private final UnlinkedFilesDialogViewModel viewModel

Constructor Detail

FileSelectionPageback to summary
public FileSelectionPage(StateManager stateManager, UnlinkedFilesDialogViewModel viewModel, ImportFormatPreferences importFormatPreferences, TaskExecutor taskExecutor)

Method Detail

cancelCurrentMetadataTaskback to summary
private void cancelCurrentMetadataTask()
cancelPreviewTasksback to summary
public void cancelPreviewTasks()

Cancels any in-flight preview work.

createContextMenuback to summary
private ContextMenu createContextMenu()
expandTreeback to summary
private void expandTree(TreeItem<?> item, boolean expand)
formatBibEntryback to summary
private String formatBibEntry(BibEntry entry)
formatParserResultback to summary
private String formatParserResult(ParserResult result)
hidePreviewPaneback to summary
private void hidePreviewPane()

impl->req~jabgui.externalfiles.unlinked-files.preview.close~1

invalidPropertyback to summary
public BooleanProperty invalidProperty()
isPreviewActiveback to summary
private boolean isPreviewActive()
isPreviewPaneVisibleback to summary
private boolean isPreviewPaneVisible()
onEnteringPageback to summary
public void onEnteringPage(Wizard wizard)

Overrides org.controlsfx.dialog.WizardPane.onEnteringPage.

Doc from org.controlsfx.dialog.WizardPane.onEnteringPage.

Called on entering a page. This is a good place to read values from wizard settings and assign them to controls on the page

Annotations
@Override
onExitingPageback to summary
public void onExitingPage(Wizard wizard)

Overrides org.controlsfx.dialog.WizardPane.onExitingPage.

Doc from org.controlsfx.dialog.WizardPane.onExitingPage.

Called on existing the page. This is a good place to read values from page controls and store them in wizard settings

Annotations
@Override
priorityIndexback to summary
private static int priorityIndex(Field field)
refreshPreviewForCurrentSelectionback to summary
private void refreshPreviewForCurrentSelection()
setupBindingsback to summary
private void setupBindings()
setupUIback to summary
private void setupUI()
showPreviewDisabledStateback to summary
private void showPreviewDisabledState(String metadataText)
showPreviewPaneback to summary
private void showPreviewPane()
shutdownback to summary
public void shutdown()

Cancels in-flight preview work and stops the preview throttler.

updateFileCountback to summary
private void updateFileCount(TreeItem<FileNodeViewModel> root)
org.jabref.gui.externalfiles back to summary

private Class FileSelectionPage.TreeContextAction

extends SimpleCommand
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final StandardActions
command

Inherited from org.jabref.gui.actions.SimpleCommand:
statusMessage

Constructor Summary

AccessConstructor and Description
public
TreeContextAction(StandardActions command)

Method Summary

Modifier and TypeMethod and Description
public void
execute()

Inherited from org.jabref.gui.actions.SimpleCommand:
getProgressprogressPropertysetExecutablestatusMessageProperty

Field Detail

commandback to summary
private final StandardActions command

Constructor Detail

TreeContextActionback to summary
public TreeContextAction(StandardActions command)

Method Detail

executeback to summary
public void execute()
Annotations
@Override