JabRef 5.15 · org.jabref.gui.preferences.journals.JournalAbbreviationsTabViewModel

Modifier and Type	Field and Description
private final SimpleListProperty<AbbreviationViewModel>	abbreviations
private final SimpleIntegerProperty	abbreviationsCount
private final JournalAbbreviationPreferences	abbreviationsPreferences
private final SimpleObjectProperty<AbbreviationViewModel>	currentAbbreviation
private final SimpleObjectProperty<AbbreviationsFileViewModel>	currentFile
private final DialogService	dialogService
private final SimpleBooleanProperty	isAbbreviationEditableAndRemovable
private final SimpleBooleanProperty	isEditableAndRemovable
private final SimpleBooleanProperty	isFileRemovable
private final SimpleBooleanProperty	isLoading
private final JournalAbbreviationRepository	journalAbbreviationRepository
private final SimpleListProperty<AbbreviationsFileViewModel>	journalFiles
private final Logger	LOGGER
private boolean	shouldWriteLists
private final TaskExecutor	taskExecutor
private final SimpleBooleanProperty	useFJournal

Access	Constructor and Description
public	JournalAbbreviationsTabViewModel(JournalAbbreviationPreferences abbreviationsPreferences, DialogService dialogService, TaskExecutor taskExecutor, JournalAbbreviationRepository journalAbbreviationRepository)

Method Summary

Modifier and Type	Method and Description
public SimpleIntegerProperty	abbreviationsCountProperty()
public SimpleListProperty<AbbreviationViewModel>	abbreviationsProperty()
public void	addAbbreviation(Abbreviation abbreviationObject) Method to add a new abbreviation to the abbreviations list property.
public void	addAbbreviation()
public void	addBuiltInList() This will load the built in abbreviation files and add it to the list of journal abbreviation files.
public void	addNewFile() This method shall be used to add a new journal abbreviation file to the set of journal abbreviation files.
public void	createFileObjects() Read all saved file paths and read their abbreviations.
public SimpleObjectProperty<AbbreviationViewModel>	currentAbbreviationProperty()
public SimpleObjectProperty<AbbreviationsFileViewModel>	currentFileProperty()
public void	deleteAbbreviation() Method to delete the abbreviation set in the currentAbbreviation property.
pack-priv void	editAbbreviation(Abbreviation abbreviationObject) Method to change the currentAbbreviation property to a new abbreviation.
public SimpleBooleanProperty	isAbbreviationEditableAndRemovable()
public SimpleBooleanProperty	isEditableAndRemovableProperty()
public SimpleBooleanProperty	isFileRemovableProperty()
public SimpleBooleanProperty	isLoadingProperty()
public SimpleListProperty<AbbreviationsFileViewModel>	journalFilesProperty()
private void	openFile(Path path to the file filePath) Checks whether the file exists or if a new file should be opened.
public void	openFile()
public void	removeAbbreviation(AbbreviationViewModel abbreviation)
public void	removeCurrentFile() This method removes the currently selected file from the set of journal abbreviation files.
public void	saveJournalAbbreviationFiles() Calls the `AbbreviationsFileViewModel#writeOrCreate()` method for each file in the journalFiles property which will overwrite the existing files with the content of the abbreviations property of the AbbreviationsFile.
public void	selectLastJournalFile() This will set the `currentFile` property to the `AbbreviationsFileViewModel` object that was added to the `journalFiles` list property lastly.
private void	setCurrentAbbreviationNameAndAbbreviationIfValid(Abbreviation abbreviationObject)
public void	setValues() Implements org.jabref.gui.preferences.PreferenceTabViewModel.setValues. This method is called when the dialog is opened, or if it is made visible after being hidden.
public void	storeSettings() Implements org.jabref.gui.preferences.PreferenceTabViewModel.storeSettings. This method first saves all external files to its internal list, then writes all abbreviations to their files and finally updates the abbreviations auto complete.
public SimpleBooleanProperty	useFJournalProperty()

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

Field Detail

abbreviations	back to summary
private final SimpleListProperty<AbbreviationViewModel> abbreviations

abbreviationsCount	back to summary
private final SimpleIntegerProperty abbreviationsCount

abbreviationsPreferences	back to summary
private final JournalAbbreviationPreferences abbreviationsPreferences

currentAbbreviation	back to summary
private final SimpleObjectProperty<AbbreviationViewModel> currentAbbreviation

currentFile	back to summary
private final SimpleObjectProperty<AbbreviationsFileViewModel> currentFile

dialogService	back to summary
private final DialogService dialogService

isAbbreviationEditableAndRemovable	back to summary
private final SimpleBooleanProperty isAbbreviationEditableAndRemovable

isEditableAndRemovable	back to summary
private final SimpleBooleanProperty isEditableAndRemovable

isFileRemovable	back to summary
private final SimpleBooleanProperty isFileRemovable

isLoading	back to summary
private final SimpleBooleanProperty isLoading

journalAbbreviationRepository	back to summary
private final JournalAbbreviationRepository journalAbbreviationRepository

journalFiles	back to summary
private final SimpleListProperty<AbbreviationsFileViewModel> journalFiles

LOGGER	back to summary
private final Logger LOGGER

shouldWriteLists	back to summary
private boolean shouldWriteLists

taskExecutor	back to summary
private final TaskExecutor taskExecutor

useFJournal	back to summary
private final SimpleBooleanProperty useFJournal

Constructor Detail

JournalAbbreviationsTabViewModel	back to summary
public JournalAbbreviationsTabViewModel(JournalAbbreviationPreferences abbreviationsPreferences, DialogService dialogService, TaskExecutor taskExecutor, JournalAbbreviationRepository journalAbbreviationRepository)

Method Detail

abbreviationsCountProperty	back to summary
public SimpleIntegerProperty abbreviationsCountProperty()

abbreviationsProperty	back to summary
public SimpleListProperty<AbbreviationViewModel> abbreviationsProperty()

addAbbreviation	back to summary
public void addAbbreviation(Abbreviation abbreviationObject) Method to add a new abbreviation to the abbreviations list property. It also sets the currentAbbreviation property to the new abbreviation.

addAbbreviation	back to summary
public void addAbbreviation()

addBuiltInList	back to summary
public void addBuiltInList() This will load the built in abbreviation files and add it to the list of journal abbreviation files.

addNewFile	back to summary
public void addNewFile() This method shall be used to add a new journal abbreviation file to the set of journal abbreviation files. It basically just calls the `openFile(Path)`} method.

createFileObjects	back to summary
public void createFileObjects() Read all saved file paths and read their abbreviations.

currentAbbreviationProperty	back to summary
public SimpleObjectProperty<AbbreviationViewModel> currentAbbreviationProperty()

currentFileProperty	back to summary
public SimpleObjectProperty<AbbreviationsFileViewModel> currentFileProperty()

deleteAbbreviation	back to summary
public void deleteAbbreviation() Method to delete the abbreviation set in the currentAbbreviation property. The currentAbbreviationProperty will be set to the previous or next abbreviation in the abbreviations property if applicable. Else it will be set to `null` if there are no abbreviations left.

editAbbreviation	back to summary
pack-priv void editAbbreviation(Abbreviation abbreviationObject) Method to change the currentAbbreviation property to a new abbreviation.

isAbbreviationEditableAndRemovable	back to summary
public SimpleBooleanProperty isAbbreviationEditableAndRemovable()

isEditableAndRemovableProperty	back to summary
public SimpleBooleanProperty isEditableAndRemovableProperty()

isFileRemovableProperty	back to summary
public SimpleBooleanProperty isFileRemovableProperty()

isLoadingProperty	back to summary
public SimpleBooleanProperty isLoadingProperty()

journalFilesProperty	back to summary
public SimpleListProperty<AbbreviationsFileViewModel> journalFilesProperty()

openFile	back to summary
private void openFile(Path filePath) Checks whether the file exists or if a new file should be opened. The file will be added to the set of journal abbreviation files. If the file also exists its abbreviations will be read and written to the abbreviations property. Parameters filePath:Path path to the file

openFile

back to summary

private void openFile(Path filePath)

Checks whether the file exists or if a new file should be opened. The file will be added to the set of journal abbreviation files. If the file also exists its abbreviations will be read and written to the abbreviations property.

Parameters

filePath:Path: path to the file

openFile	back to summary
public void openFile()

removeAbbreviation	back to summary
public void removeAbbreviation(AbbreviationViewModel abbreviation)

removeCurrentFile back to summary

removeCurrentFile	back to summary
public void removeCurrentFile() This method removes the currently selected file from the set of journal abbreviation files. This will not remove existing files from the file system. The `activeFile` property will always change to the previous file in the `journalFiles` list property, except the first file is selected. If so the next file will be selected except if there are no more files than the `activeFile` property will be set to `null`.

public void removeCurrentFile()

This method removes the currently selected file from the set of journal abbreviation files. This will not remove existing files from the file system. The activeFile property will always change to the previous file in the journalFiles list property, except the first file is selected. If so the next file will be selected except if there are no more files than the activeFile property will be set to null.

saveJournalAbbreviationFiles	back to summary
public void saveJournalAbbreviationFiles() Calls the `AbbreviationsFileViewModel#writeOrCreate()` method for each file in the journalFiles property which will overwrite the existing files with the content of the abbreviations property of the AbbreviationsFile. Non-existing files will be created.

selectLastJournalFile	back to summary
public void selectLastJournalFile() This will set the `currentFile` property to the `AbbreviationsFileViewModel` object that was added to the `journalFiles` list property lastly. If there are no files in the list property this method will do nothing as the `currentFile` property is already `null`.

setCurrentAbbreviationNameAndAbbreviationIfValid	back to summary
private void setCurrentAbbreviationNameAndAbbreviationIfValid(Abbreviation abbreviationObject)

setValues	back to summary
public void setValues() Implements org.jabref.gui.preferences.PreferenceTabViewModel.setValues. Doc from org.jabref.gui.preferences.PreferenceTabViewModel.setValues. This method is called when the dialog is opened, or if it is made visible after being hidden. The tab should update all its values. This is the ONLY PLACE to set values for the fields in the tab. It is ILLEGAL to set values only at construction time, because the dialog will be reused and updated. Annotations @Override

setValues

back to summary

public void setValues()

Implements org.jabref.gui.preferences.PreferenceTabViewModel.setValues.

Doc from org.jabref.gui.preferences.PreferenceTabViewModel.setValues.

This method is called when the dialog is opened, or if it is made visible after being hidden. The tab should update all its values. This is the ONLY PLACE to set values for the fields in the tab. It is ILLEGAL to set values only at construction time, because the dialog will be reused and updated.

Annotations

@Override

storeSettings	back to summary
public void storeSettings() Implements org.jabref.gui.preferences.PreferenceTabViewModel.storeSettings. This method first saves all external files to its internal list, then writes all abbreviations to their files and finally updates the abbreviations auto complete. Annotations @Override

storeSettings

back to summary

public void storeSettings()

Implements org.jabref.gui.preferences.PreferenceTabViewModel.storeSettings.

This method first saves all external files to its internal list, then writes all abbreviations to their files and finally updates the abbreviations auto complete.

Annotations

@Override

useFJournalProperty	back to summary
public SimpleBooleanProperty useFJournalProperty()

public Class JournalAbbreviationsTabViewModel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail