Verified Owner
Top Fields Constructors Methods
org.jabref.gui.preferences.citationkeypattern

public Class CitationKeyPatternTabViewModel

extends Object
implements PreferenceTabViewModel
Class Inheritance
All Implemented Interfaces
org.jabref.gui.preferences.PreferenceTabViewModel
Imports
javafx.beans.property.BooleanProperty, .ListProperty, .ObjectProperty, .SimpleBooleanProperty, .SimpleListProperty, .SimpleObjectProperty, .SimpleStringProperty, .StringProperty, javafx.collections.FXCollections, org.jabref.gui.commonfxcontrols.CitationKeyPatternsPanelItemModel, .CitationKeyPatternsPanelViewModel, org.jabref.gui.preferences.PreferenceTabViewModel, org.jabref.logic.citationkeypattern.CitationKeyPatternPreferences, .GlobalCitationKeyPatterns, org.jabref.logic.importer.ImporterPreferences

Field Summary

Modifier and TypeField and Description
private final ObjectProperty<CitationKeyPatternsPanelItemModel>
private final BooleanProperty
private final BooleanProperty
private final ImporterPreferences
importerPreferences

The preference for whether to use the key generator on import is different from how it is configured.

private final CitationKeyPatternPreferences
private final StringProperty
private final StringProperty
private final BooleanProperty
private final BooleanProperty
private final BooleanProperty
private final BooleanProperty
private final BooleanProperty
private final ListProperty<CitationKeyPatternsPanelItemModel>
private final BooleanProperty
private final StringProperty

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public ObjectProperty<CitationKeyPatternsPanelItemModel>
public BooleanProperty
public BooleanProperty
public StringProperty
public StringProperty
public BooleanProperty
public BooleanProperty
public BooleanProperty
public BooleanProperty
public BooleanProperty
public ListProperty<CitationKeyPatternsPanelItemModel>
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 is called when the user presses OK in the Preferences dialog.

public BooleanProperty
public StringProperty
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

defaultKeyPatternPropertyback to summary
private final ObjectProperty<CitationKeyPatternsPanelItemModel> defaultKeyPatternProperty
generateKeyOnImportPropertyback to summary
private final BooleanProperty generateKeyOnImportProperty
generateOnSavePropertyback to summary
private final BooleanProperty generateOnSaveProperty
importerPreferencesback to summary
private final ImporterPreferences importerPreferences

The preference for whether to use the key generator on import is different from how it is configured. In the UI, there is no better place to put the option than the Citation Key Generator tab. However, shifting the preference to CitationKeyPatternPreferences would break the abstraction or hierarchy. Hence, we keep the preference in ImporterPreferences, but for the UI, we initialize it here.

keyPatternPreferencesback to summary
private final CitationKeyPatternPreferences keyPatternPreferences
keyPatternRegexPropertyback to summary
private final StringProperty keyPatternRegexProperty
keyPatternReplacementPropertyback to summary
private final StringProperty keyPatternReplacementProperty
letterAlwaysAddPropertyback to summary
private final BooleanProperty letterAlwaysAddProperty
letterStartAPropertyback to summary
private final BooleanProperty letterStartAProperty
letterStartBPropertyback to summary
private final BooleanProperty letterStartBProperty
overwriteAllowPropertyback to summary
private final BooleanProperty overwriteAllowProperty
overwriteWarningPropertyback to summary
private final BooleanProperty overwriteWarningProperty
patternListPropertyback to summary
private final ListProperty<CitationKeyPatternsPanelItemModel> patternListProperty
transliterateFieldsForCitationKeyPropertyback to summary
private final BooleanProperty transliterateFieldsForCitationKeyProperty
unwantedCharactersPropertyback to summary
private final StringProperty unwantedCharactersProperty

Constructor Detail

CitationKeyPatternTabViewModelback to summary
public CitationKeyPatternTabViewModel(CitationKeyPatternPreferences keyPatternPreferences, ImporterPreferences importerPreferences)

Method Detail

defaultKeyPatternPropertyback to summary
public ObjectProperty<CitationKeyPatternsPanelItemModel> defaultKeyPatternProperty()
generateKeyOnImportPropertyback to summary
public BooleanProperty generateKeyOnImportProperty()
generateOnSavePropertyback to summary
public BooleanProperty generateOnSaveProperty()
keyPatternRegexPropertyback to summary
public StringProperty keyPatternRegexProperty()
keyPatternReplacementPropertyback to summary
public StringProperty keyPatternReplacementProperty()
letterAlwaysAddPropertyback to summary
public BooleanProperty letterAlwaysAddProperty()
letterStartAPropertyback to summary
public BooleanProperty letterStartAProperty()
letterStartBPropertyback to summary
public BooleanProperty letterStartBProperty()
overwriteAllowPropertyback to summary
public BooleanProperty overwriteAllowProperty()
overwriteWarningPropertyback to summary
public BooleanProperty overwriteWarningProperty()
patternListPropertyback to summary
public ListProperty<CitationKeyPatternsPanelItemModel> patternListProperty()
setValuesback 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
storeSettingsback to summary
public void storeSettings()

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

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

This method is called when the user presses OK in the Preferences dialog. Implementing classes must make sure all settings presented get stored in PreferencesService.

Annotations
@Override
transliterateFieldsForCitationKeyPropertyback to summary
public BooleanProperty transliterateFieldsForCitationKeyProperty()
unwantedCharactersPropertyback to summary
public StringProperty unwantedCharactersProperty()