pack-priv Class ColumnPreferencesApplier

Class Inheritance

extends Object

java.lang.Object
org.jabref.gui.maintable.ColumnPreferencesApplier

Annotations

@NullMarked

Imports

java.util.ArrayList, .List, .Optional, java.util.stream.Collectors, javafx.beans.value.ChangeListener, javafx.collections.ListChangeListener, javafx.scene.control.TableColumn, .TableView, org.jabref.gui.maintable.columns.MainTableColumn, org.jspecify.annotations.NullMarked

Applies the column preferences (columns, sort order, resize policy) to the main table: initially and whenever they change, e.g., in the preferences dialog.

This is the preferences-to-table direction. The opposite direction is ColumnPreferencesRecorder. Both directions compare columns by ColumnPreferencesRecorder#toPersistedModels(List). Each change is applied with a single setAll, so that the write-back of the table equals the preferences and ends the round trip.

All main tables share the same preferences. Hence, reordering, adding, removing or sorting columns in one library tab is applied to the main tables of all other open library tabs as well. This is intended: the column preferences are global, so all tables show the state that will be restored at the next start.

New columns are created from the model instances held by the preferences. Resized widths are persisted only because table and preferences share these instances (see ColumnPreferences).

Field Summary

Modifier and Type	Field and Description
private final MainTableColumnFactory	columnFactory
private final ListChangeListener<MainTableColumnModel>	columnsListener
private final MainTablePreferences	mainTablePreferences
private final ChangeListener<Boolean>	resizeColumnsListener
private final ListChangeListener<MainTableColumnModel>	sortOrderListener
private final TableView<BibEntryTableViewModel>	table

Constructor Summary

Access	Constructor and Description
pack-priv	ColumnPreferencesApplier(TableView<BibEntryTableViewModel> table, MainTableColumnFactory columnFactory, MainTablePreferences mainTablePreferences)

Method Summary

Modifier and Type	Method and Description
private void	applyColumns()
private void	applyResizePolicy(boolean resizeColumnsToFit)
pack-priv void	applySortOrder()
pack-priv void	bind() Creates the columns, applies the resize policy and follows later changes of the preferences.
private static List<MainTableColumnModel>	configured(List<MainTableColumnModel> models)
private Optional<TableColumn<BibEntryTableViewModel, ?>>	findColumn(MainTableColumnModel model)
private Optional<TableColumn<BibEntryTableViewModel, ?>>	findMatchCategoryColumn()
pack-priv void	unbind() The preferences outlive the table, so the listeners have to be removed when the library tab closes.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

columnFactory	back to summary
private final MainTableColumnFactory columnFactory

columnsListener	back to summary
private final ListChangeListener<MainTableColumnModel> columnsListener

mainTablePreferences	back to summary
private final MainTablePreferences mainTablePreferences

resizeColumnsListener	back to summary
private final ChangeListener<Boolean> resizeColumnsListener

sortOrderListener	back to summary
private final ListChangeListener<MainTableColumnModel> sortOrderListener

table	back to summary
private final TableView<BibEntryTableViewModel> table

Constructor Detail

ColumnPreferencesApplier	back to summary
pack-priv ColumnPreferencesApplier(TableView<BibEntryTableViewModel> table, MainTableColumnFactory columnFactory, MainTablePreferences mainTablePreferences)

Method Detail

applyColumns	back to summary
private void applyColumns()

applyResizePolicy	back to summary
private void applyResizePolicy(boolean resizeColumnsToFit)

applySortOrder	back to summary
pack-priv void applySortOrder()

bind back to summary

bind	back to summary
pack-priv void bind() Creates the columns, applies the resize policy and follows later changes of the preferences. The initial sort order is not applied here, because sorting a large library is expensive. The caller decides when to call `applySortOrder()`.

pack-priv void bind()

Creates the columns, applies the resize policy and follows later changes of the preferences.

The initial sort order is not applied here, because sorting a large library is expensive. The caller decides when to call applySortOrder().

configured	back to summary
private static List<MainTableColumnModel> configured(List<MainTableColumnModel> models)

findColumn	back to summary
private Optional<TableColumn<BibEntryTableViewModel, ?>> findColumn(MainTableColumnModel model)

findMatchCategoryColumn	back to summary
private Optional<TableColumn<BibEntryTableViewModel, ?>> findMatchCategoryColumn()

unbind	back to summary
pack-priv void unbind() The preferences outlive the table, so the listeners have to be removed when the library tab closes.