Top Description Fields Constructors Methods
org.jabref.preferences

public Class JabRefPreferences

extends Object
implements PreferencesService
Class Inheritance
All Implemented Interfaces
org.jabref.preferences.PreferencesService
Annotations
@Singleton
@org.jvnet.hk2.annotations.Service
Imports
java.io.File, .IOException, .InputStream, .OutputStream, java.nio.charset.StandardCharsets, java.nio.file.Files, .Path, java.util.ArrayList, .Arrays, .Collection, .Collections, .EnumSet, .HashMap, .HashSet, .LinkedHashMap, .List, .Locale, .Map, .Objects, .Optional, .SequencedMap, .Set, .TreeSet, java.util.prefs.BackingStoreException, .InvalidPreferencesFormatException, .Preferences, java.util.stream.Collectors, .Stream, javafx.beans.InvalidationListener, javafx.collections.ListChangeListener, .ObservableList, .SetChangeListener, javafx.scene.control.TableColumn.SortType, org.jabref.gui.autocompleter.AutoCompleteFirstNameMode, .AutoCompletePreferences, org.jabref.gui.duplicationFinder.DuplicateResolverDialog, org.jabref.gui.entryeditor.EntryEditorPreferences, org.jabref.gui.externalfiletype.ExternalFileType, .ExternalFileTypes, org.jabref.gui.groups.GroupViewMode, .GroupsPreferences, org.jabref.gui.keyboard.KeyBindingRepository, org.jabref.gui.maintable.ColumnPreferences, .MainTableColumnModel, .MainTablePreferences, .NameDisplayPreferences, .NameDisplayPreferences.AbbreviationStyle, .NameDisplayPreferences.DisplayStyle, org.jabref.gui.mergeentries.DiffMode, org.jabref.gui.push.PushToApplications, org.jabref.gui.search.SearchDisplayMode, org.jabref.gui.sidepane.SidePaneType, org.jabref.gui.specialfields.SpecialFieldsPreferences, org.jabref.gui.theme.Theme, org.jabref.logic.JabRefException, org.jabref.logic.bibtex.FieldPreferences, org.jabref.logic.bst.BstPreviewLayout, org.jabref.logic.citationkeypattern.CitationKeyPattern, .CitationKeyPatternPreferences, .GlobalCitationKeyPatterns, org.jabref.logic.citationstyle.CitationStyle, .CitationStylePreviewLayout, org.jabref.logic.cleanup.FieldFormatterCleanups, org.jabref.logic.exporter.BibDatabaseWriter, .MetaDataSerializer, .SelfContainedSaveConfiguration, .TemplateExporter, org.jabref.logic.importer.ImportFormatPreferences, .ImporterPreferences, org.jabref.logic.importer.fetcher.ACMPortalFetcher, .DBLPFetcher, .DoiFetcher, .GrobidPreferences, .IEEE, .SpringerFetcher, org.jabref.logic.importer.fileformat.CustomImporter, org.jabref.logic.importer.util.MetaDataParser, org.jabref.logic.journals.JournalAbbreviationPreferences, .JournalAbbreviationRepository, org.jabref.logic.l10n.Language, .Localization, org.jabref.logic.layout.LayoutFormatterPreferences, .TextBasedPreviewLayout, org.jabref.logic.layout.format.NameFormatterPreferences, org.jabref.logic.net.ProxyPreferences, org.jabref.logic.net.ssl.SSLPreferences, .TrustStoreManager, org.jabref.logic.openoffice.OpenOfficePreferences, org.jabref.logic.openoffice.style.StyleLoader, org.jabref.logic.preferences.DOIPreferences, .FetcherApiKey, .OwnerPreferences, .TimestampPreferences, org.jabref.logic.preview.PreviewLayout, org.jabref.logic.protectedterms.ProtectedTermsLoader, .ProtectedTermsPreferences, org.jabref.logic.push.CitationCommandString, org.jabref.logic.remote.RemotePreferences, org.jabref.logic.shared.prefs.SharedDatabasePreferences, org.jabref.logic.shared.security.Password, org.jabref.logic.util.OS, .Version, org.jabref.logic.util.io.AutoLinkPreferences, .FileHistory, org.jabref.logic.xmp.XmpPreferences, org.jabref.model.database.BibDatabaseMode, org.jabref.model.entry.BibEntryType, .BibEntryTypesManager, org.jabref.model.entry.field.Field, .FieldFactory, .InternalField, .StandardField, org.jabref.model.entry.types.EntryType, .EntryTypeFactory, org.jabref.model.groups.GroupHierarchyType, org.jabref.model.metadata.SaveOrder, .SelfContainedSaveOrder, org.jabref.model.search.rules.SearchRules, org.jabref.model.strings.StringUtil, com.airhacks.afterburner.injection.Injector, com.github.javakeyring.Keyring, com.github.javakeyring.PasswordAccessException, com.google.common.annotations.VisibleForTesting, com.google.common.base.Splitter, com.tobiasdiez.easybind.EasyBind, jakarta.inject.Singleton, org.jvnet.hk2.annotations.Service, org.slf4j.Logger, .LoggerFactory

The JabRefPreferences class provides the preferences and their defaults using the JDK java.util.prefs class.

Internally it defines symbols used to pick a value from the java.util.prefs interface and keeps a hashmap with all the default values.

There are still some similar preferences classes (org.jabref.logic.openoffice.OpenOfficePreferences and org.jabref.logic.shared.prefs.SharedDatabasePreferences) which also use the java.util.prefs API.

Field Summary

Modifier and TypeField and Description
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
private static final String
public static final String
public static final String
private AutoCompletePreferences
public static final String
private static final String
private static final String
private static final String
private AutoLinkPreferences
public static final String
public static final String
public static final String
private BibEntryPreferences
public static final String
private static final String
public static final String
public static final String
private CitationKeyPatternPreferences
public static final String
public static final String
public static final String
public static final String
private CleanupPreferences
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
private static final String
public static final String
public static final String
public final Map<String, Object>
defaults

HashMap that contains all preferences which are set by default

public static final String
public static final String
private DOIPreferences
private static final String
public static final String
public static final String
public static final String
public static final String
ENTRY_EDITOR_PREVIEW_DIVIDER_POS

Holds the horizontal divider position of the preview view when it is shown inside the entry editor

private EntryEditorPreferences
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
private static final int
private static final int
private static final int
private ExportPreferences
public static final String
private static final String
private ExternalApplicationsPreferences
public static final String
private static final String
private static final String
private static final String
private FieldPreferences
public static final String
private FilePreferences
private static final String
private static final String
public static final String
public static final String
public static final String
public static final String
public static final String
private GrobidPreferences
private static final String
public static final String
private GroupsPreferences
private GuiPreferences
public static final String
public static final String
public static final String
public static final String
private ImporterPreferences
public static final String
private InternalPreferences
public static final String
private JournalAbbreviationPreferences
public static final String
public static final String
public static final String
public static final String
private KeyBindingRepository
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
private LibraryPreferences
public static final String
private static final Logger
public static final String
public static final String
private ColumnPreferences
private MainTablePreferences
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
private MergeDialogPreferences
private MrDlibPreferences
public static final String
public static final String
private NameDisplayPreferences
private NameFormatterPreferences
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
OO_EXECUTABLE_PATH

The OpenOffice/LibreOffice connection preferences are: OO_PATH main directory for OO/LO installation, used to detect location on Win/macOS when using manual connect OO_EXECUTABLE_PATH path to soffice-file OO_JARS_PATH directory that contains juh.jar, jurt.jar, ridl.jar, unoil.jar OO_SYNC_WHEN_CITING true if the reference list is updated when adding a new citation OO_SHOW_PANEL true if the OO panel is shown on startup OO_USE_ALL_OPEN_DATABASES true if all databases should be used when citing OO_BIBLIOGRAPHY_STYLE_FILE path to the used style file OO_EXTERNAL_STYLE_FILES list with paths to external style files STYLES_*_* size and position of "Select style" dialog

public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
private OpenOfficePreferences
public static final String
public static final String
private OwnerPreferences
public static final String
public static final String
private final Preferences
private static final String
private static final Preferences
public static final String
public static final String
public static final String
public static final String
private PreviewPreferences
private static final String
private static final String
private static final String
private static final String
private ProtectedTermsPreferences
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private ProxyPreferences
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
private PushToApplicationPreferences
public static final String
public static final String
private static final String
private RemotePreferences
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
private ColumnPreferences
private SearchPreferences
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
private SidePanePreferences
private static JabRefPreferences
public static final String
public static final String
public static final String
private SpecialFieldsPreferences
private SSLPreferences
public static final String
public static final Character
public static final String
public static final String
public static final String
public static final String
private TimestampPreferences
public static final String
private static final String
public static final String
public static final String
private static final String
public static final String
public static final String
public static final String
public static final String
private static final String
public static final String
private static final String
private static final String
private String
userAndHost

Cache variables

public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
private WorkspacePreferences
public static final String
private XmpPreferences

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
private void
public void
clear()

Implements org.jabref.preferences.PreferencesService.clear.

Clear all preferences.

private void
private void
private void
private void
private void
pack-priv static String
pack-priv static List<String>
public void
deleteKey(String key)

Implements org.jabref.preferences.PreferencesService.deleteKey.

Removes the given key from the preferences.

public void
exportPreferences(Path
Path to export to
path
)

Implements org.jabref.preferences.PreferencesService.exportPreferences.

Exports Preferences to an XML file.

public void
flush()

Implements org.jabref.preferences.PreferencesService.flush.

Calling this method will write all preferences into the preference store.

public String
get(String key)

public String
get(String key, String def)

public Optional<String>
public AutoCompletePreferences
private AutoLinkPreferences.CitationKeyDependency
public AutoLinkPreferences
public BibEntryPreferences
private List<BibEntryType>
public boolean
public boolean
getBoolean(String key, boolean def)

private boolean
public CitationKeyPatternPreferences
public CleanupPreferences
private static List<String>
private List<MainTableColumnModel>
getColumns(String columnNamesList, String columnWidthList, String sortTypeList, double defaultWidth)

private List<MainTableColumnModel>
getColumnSortOrder(String sortOrderList, List<MainTableColumnModel> tableColumns)

private static List<String>
private static List<String>
private static List<String>
public BibEntryTypesManager
private List<TemplateExporter>
private Set<CustomImporter>
private static EnumSet<CleanupPreferences.CleanupStep>
public CleanupPreferences
private SequencedMap<String, Set<Field>>
public Map<String, Object>
public DOIPreferences
public double
private double
public String
public EntryEditorPreferences
private Map<String, Set<Field>>

Returns:

A map of the currently defined tabs in the entry editor from scratch to cache
getEntryEditorTabs
()

Get a Map of defined tab names to default tab fields.

public ExportPreferences
private SaveOrder
public ExternalApplicationsPreferences
private Set<FetcherApiKey>
private List<String>
public FieldPreferences
private FileHistory
public FilePreferences
private GlobalCitationKeyPatterns
public GrobidPreferences
public GroupsPreferences
public GuiPreferences
public ImporterPreferences
public ImportFormatPreferences
public static JabRefPreferences

Returns:

Instance of JaRefPreferences
getInstance
()
Deprecated Use PreferencesService instead

public int
public int
public InternalPreferences
public JournalAbbreviationPreferences
public KeyBindingRepository
private CitationKeyPatternPreferences.KeySuffix
private Language
public LayoutFormatterPreferences
public LibraryPreferences
public ColumnPreferences
public MainTablePreferences
public MergeDialogPreferences
public MrDlibPreferences
private NameDisplayPreferences.AbbreviationStyle
public NameDisplayPreferences
private NameDisplayPreferences.DisplayStyle
public NameFormatterPreferences
private Object
public OpenOfficePreferences
public OwnerPreferences
private Path
getPath(String key, Path defaultValue)

Returns a Path

public Map<String, Object>
private static Preferences
private int
private List<PreviewLayout>
public PreviewPreferences
public ProtectedTermsPreferences
private String
public ProxyPreferences
public PushToApplicationPreferences
public RemotePreferences
public ColumnPreferences
public SearchPreferences
public SelfContainedSaveConfiguration
public SelfContainedSaveOrder
getSelfContainedTableSaveOrder()

For the export configuration, generates the SelfContainedSaveOrder having the reference to TABLE resolved.

private List<String>
getSeries(String key)

Returns a list of Strings stored by key+N with N being an incrementing number

public SidePanePreferences
private Map<SidePaneType, Integer>
public SpecialFieldsPreferences
public SSLPreferences
public List<String>
getStringList(String key)

Returns a List of Strings containing the chosen columns.

public TimestampPreferences
private String
private Set<SidePaneType>
public WorkspacePreferences
public XmpPreferences
public boolean

Returns:

true if the key is set, false otherwise.
hasKey
(String
The key to check.
key
)

Check whether a key is set (differently from null).

public void
importPreferences(Path
Path of file to import from
file
)

Implements org.jabref.preferences.PreferencesService.importPreferences.

Imports Preferences from an XML file.

private void
purgeSeries(String prefix, int
or higher.
number
)

Removes all entries keyed by prefix+number, where number is equal to or higher than the given number.

public void
put(String key, String value)

public void
putBoolean(String key, boolean value)

public void
putDouble(String key, double value)

public void
putInt(String key, int value)

public void
putInt(String key, Number value)

public void
putStringList(String key, List<String> value)

Puts a list of strings into the Preferences, by linking its elements with a STRINGLIST_DELIMITER into a single string.

private void
public void
private void
private void
storeBibEntryTypes(Collection<BibEntryType> bibEntryTypes, BibDatabaseMode bibDatabaseMode)

private void
storeBstPaths(List<Path> bstPaths)

public void
private void
private void
private void
storeEntryEditorTabs(Map<String, Set<Field>>
a map of tab names and the corresponding set of fields to be displayed in
customTabs
)

Stores the defined tabs and corresponding fields in the preferences.

private void
private void
private void
private void
public void
private void
private void
private void
private void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ABBR_AUTHOR_NAMESback to summary
public static final String ABBR_AUTHOR_NAMES
ACCEPT_RECOMMENDATIONSback to summary
public static final String ACCEPT_RECOMMENDATIONS
ADD_CREATION_DATEback to summary
public static final String ADD_CREATION_DATE
ADD_MODIFICATION_DATEback to summary
public static final String ADD_MODIFICATION_DATE
ALLOW_INTEGER_EDITION_BIBTEXback to summary
public static final String ALLOW_INTEGER_EDITION_BIBTEX
ASK_AUTO_NAMING_PDFS_AGAINback to summary
public static final String ASK_AUTO_NAMING_PDFS_AGAIN
AUTO_ASSIGN_GROUPback to summary
public static final String AUTO_ASSIGN_GROUP
AUTO_COMPLETEback to summary
private static final String AUTO_COMPLETE
AUTO_OPEN_FORMback to summary
public static final String AUTO_OPEN_FORM
AUTO_RESIZE_MODEback to summary
public static final String AUTO_RESIZE_MODE
autoCompletePreferencesback to summary
private AutoCompletePreferences autoCompletePreferences
AUTOCOMPLETER_COMPLETE_FIELDSback to summary
public static final String AUTOCOMPLETER_COMPLETE_FIELDS
AUTOCOMPLETER_FIRST_LASTback to summary
private static final String AUTOCOMPLETER_FIRST_LAST
AUTOCOMPLETER_FIRSTNAME_MODEback to summary
private static final String AUTOCOMPLETER_FIRSTNAME_MODE
AUTOCOMPLETER_LAST_FIRSTback to summary
private static final String AUTOCOMPLETER_LAST_FIRST
autoLinkPreferencesback to summary
private AutoLinkPreferences autoLinkPreferences
AVOID_OVERWRITING_KEYback to summary
public static final String AVOID_OVERWRITING_KEY
BACKUP_DIRECTORYback to summary
public static final String BACKUP_DIRECTORY
BASE_DOI_URIback to summary
public static final String BASE_DOI_URI
bibEntryPreferencesback to summary
private BibEntryPreferences bibEntryPreferences
BIBLATEX_DEFAULT_MODEback to summary
public static final String BIBLATEX_DEFAULT_MODE
BIND_NAMESback to summary
private static final String BIND_NAMES
BINDINGSback to summary
public static final String BINDINGS
CITATION_KEY_PATTERNS_NODEback to summary
public static final String CITATION_KEY_PATTERNS_NODE
citationKeyPatternPreferencesback to summary
private CitationKeyPatternPreferences citationKeyPatternPreferences
CITE_COMMANDback to summary
public static final String CITE_COMMAND
CLEANUP_FIELD_FORMATTERSback to summary
public static final String CLEANUP_FIELD_FORMATTERS
CLEANUP_FIELD_FORMATTERS_ENABLEDback to summary
public static final String CLEANUP_FIELD_FORMATTERS_ENABLED
CLEANUP_JOBSback to summary
public static final String CLEANUP_JOBS
cleanupPreferencesback to summary
private CleanupPreferences cleanupPreferences
COLUMN_NAMESback to summary
public static final String COLUMN_NAMES
COLUMN_SORT_ORDERback to summary
public static final String COLUMN_SORT_ORDER
COLUMN_SORT_TYPESback to summary
public static final String COLUMN_SORT_TYPES
COLUMN_WIDTHSback to summary
public static final String COLUMN_WIDTHS
CONFIRM_DELETEback to summary
public static final String CONFIRM_DELETE
CONFIRM_LINKED_FILE_DELETEback to summary
public static final String CONFIRM_LINKED_FILE_DELETE
CONSOLE_COMMANDback to summary
public static final String CONSOLE_COMMAND
CREATE_BACKUPback to summary
public static final String CREATE_BACKUP
CUSTOM_EXPORT_FORMATback to summary
public static final String CUSTOM_EXPORT_FORMAT
CUSTOM_IMPORT_FORMATback to summary
public static final String CUSTOM_IMPORT_FORMAT
CUSTOM_TAB_FIELDSback to summary
public static final String CUSTOM_TAB_FIELDS
CUSTOM_TAB_NAMEback to summary
public static final String CUSTOM_TAB_NAME
CUSTOMIZED_BIBLATEX_TYPESback to summary
public static final String CUSTOMIZED_BIBLATEX_TYPES
CUSTOMIZED_BIBTEX_TYPESback to summary
public static final String CUSTOMIZED_BIBTEX_TYPES
CYCLE_PREVIEWback to summary
public static final String CYCLE_PREVIEW
CYCLE_PREVIEW_POSback to summary
public static final String CYCLE_PREVIEW_POS
DEFAULT_CITATION_KEY_PATTERNback to summary
public static final String DEFAULT_CITATION_KEY_PATTERN
DEFAULT_ENCODINGback to summary
public static final String DEFAULT_ENCODING
DEFAULT_HIERARCHICAL_CONTEXTback to summary
private static final String DEFAULT_HIERARCHICAL_CONTEXT
DEFAULT_OWNERback to summary
public static final String DEFAULT_OWNER
DEFAULT_SHOW_SOURCEback to summary
public static final String DEFAULT_SHOW_SOURCE
defaultsback to summary
public final Map<String, Object> defaults

HashMap that contains all preferences which are set by default

DISPLAY_GROUP_COUNTback to summary
public static final String DISPLAY_GROUP_COUNT
DO_NOT_RESOLVE_STRINGSback to summary
public static final String DO_NOT_RESOLVE_STRINGS
doiPreferencesback to summary
private DOIPreferences doiPreferences
DOWNLOAD_LINKED_FILESback to summary
private static final String DOWNLOAD_LINKED_FILES
DUPLICATE_RESOLVER_DECISION_RESULT_ALL_ENTRIESback to summary
public static final String DUPLICATE_RESOLVER_DECISION_RESULT_ALL_ENTRIES
EMAIL_SUBJECTback to summary
public static final String EMAIL_SUBJECT
ENTRY_EDITOR_HEIGHTback to summary
public static final String ENTRY_EDITOR_HEIGHT
ENTRY_EDITOR_PREVIEW_DIVIDER_POSback to summary
public static final String ENTRY_EDITOR_PREVIEW_DIVIDER_POS

Holds the horizontal divider position of the preview view when it is shown inside the entry editor

entryEditorPreferencesback to summary
private EntryEditorPreferences entryEditorPreferences
EXPORT_IN_ORIGINAL_ORDERback to summary
public static final String EXPORT_IN_ORIGINAL_ORDER
EXPORT_IN_SPECIFIED_ORDERback to summary
public static final String EXPORT_IN_SPECIFIED_ORDER
EXPORT_PRIMARY_SORT_DESCENDINGback to summary
public static final String EXPORT_PRIMARY_SORT_DESCENDING
EXPORT_PRIMARY_SORT_FIELDback to summary
public static final String EXPORT_PRIMARY_SORT_FIELD
EXPORT_SECONDARY_SORT_DESCENDINGback to summary
public static final String EXPORT_SECONDARY_SORT_DESCENDING
EXPORT_SECONDARY_SORT_FIELDback to summary
public static final String EXPORT_SECONDARY_SORT_FIELD
EXPORT_TERTIARY_SORT_DESCENDINGback to summary
public static final String EXPORT_TERTIARY_SORT_DESCENDING
EXPORT_TERTIARY_SORT_FIELDback to summary
public static final String EXPORT_TERTIARY_SORT_FIELD
EXPORT_WORKING_DIRECTORYback to summary
public static final String EXPORT_WORKING_DIRECTORY
EXPORTER_EXTENSION_INDEXback to summary
private static final int EXPORTER_EXTENSION_INDEX
EXPORTER_FILENAME_INDEXback to summary
private static final int EXPORTER_FILENAME_INDEX
EXPORTER_NAME_INDEXback to summary
private static final int EXPORTER_NAME_INDEX
exportPreferencesback to summary
private ExportPreferences exportPreferences
EXTERNAL_FILE_TYPESback to summary
public static final String EXTERNAL_FILE_TYPES
EXTERNAL_JOURNAL_LISTSback to summary
private static final String EXTERNAL_JOURNAL_LISTS
externalApplicationsPreferencesback to summary
private ExternalApplicationsPreferences externalApplicationsPreferences
EXTRA_FILE_COLUMNSback to summary
public static final String EXTRA_FILE_COLUMNS
FETCHER_CUSTOM_KEY_NAMESback to summary
private static final String FETCHER_CUSTOM_KEY_NAMES
FETCHER_CUSTOM_KEY_PERSISTback to summary
private static final String FETCHER_CUSTOM_KEY_PERSIST
FETCHER_CUSTOM_KEY_USESback to summary
private static final String FETCHER_CUSTOM_KEY_USES
fieldPreferencesback to summary
private FieldPreferences fieldPreferences
FILE_BROWSER_COMMANDback to summary
public static final String FILE_BROWSER_COMMAND
filePreferencesback to summary
private FilePreferences filePreferences
FONT_FAMILYback to summary
private static final String FONT_FAMILY
FULLTEXT_INDEX_LINKED_FILESback to summary
private static final String FULLTEXT_INDEX_LINKED_FILES
GENERATE_KEY_ON_IMPORTback to summary
public static final String GENERATE_KEY_ON_IMPORT
GENERATE_KEYS_BEFORE_SAVINGback to summary
public static final String GENERATE_KEYS_BEFORE_SAVING
GROBID_ENABLEDback to summary
public static final String GROBID_ENABLED
GROBID_OPT_OUTback to summary
public static final String GROBID_OPT_OUT
GROBID_URLback to summary
public static final String GROBID_URL
grobidPreferencesback to summary
private GrobidPreferences grobidPreferences
GROUP_INTERSECT_UNION_VIEW_MODEback to summary
private static final String GROUP_INTERSECT_UNION_VIEW_MODE
GROUP_SIDEPANE_VISIBLEback to summary
public static final String GROUP_SIDEPANE_VISIBLE
groupsPreferencesback to summary
private GroupsPreferences groupsPreferences
guiPreferencesback to summary
private GuiPreferences guiPreferences
ID_ENTRY_GENERATORback to summary
public static final String ID_ENTRY_GENERATOR
IMPORT_FILEDIRPATTERNback to summary
public static final String IMPORT_FILEDIRPATTERN
IMPORT_FILENAMEPATTERNback to summary
public static final String IMPORT_FILENAMEPATTERN
IMPORT_WORKING_DIRECTORYback to summary
public static final String IMPORT_WORKING_DIRECTORY
importerPreferencesback to summary
private ImporterPreferences importerPreferences
IMPORTERS_ENABLEDback to summary
public static final String IMPORTERS_ENABLED
internalPreferencesback to summary
private InternalPreferences internalPreferences
JOURNAL_POPUPback to summary
public static final String JOURNAL_POPUP
journalAbbreviationPreferencesback to summary
private JournalAbbreviationPreferences journalAbbreviationPreferences
KEY_GEN_ALWAYS_ADD_LETTERback to summary
public static final String KEY_GEN_ALWAYS_ADD_LETTER
KEY_GEN_FIRST_LETTER_Aback to summary
public static final String KEY_GEN_FIRST_LETTER_A
KEY_PATTERN_REGEXback to summary
public static final String KEY_PATTERN_REGEX
KEY_PATTERN_REPLACEMENTback to summary
public static final String KEY_PATTERN_REPLACEMENT
keyBindingRepositoryback to summary
private KeyBindingRepository keyBindingRepository
KEYWORD_SEPARATORback to summary
public static final String KEYWORD_SEPARATOR
KINDLE_EMAILback to summary
public static final String KINDLE_EMAIL
LANGUAGEback to summary
public static final String LANGUAGE
LAST_EDITEDback to summary
public static final String LAST_EDITED
LAST_FOCUSEDback to summary
public static final String LAST_FOCUSED
LAST_USED_EXPORTback to summary
public static final String LAST_USED_EXPORT
libraryPreferencesback to summary
private LibraryPreferences libraryPreferences
LOCAL_AUTO_SAVEback to summary
public static final String LOCAL_AUTO_SAVE
LOGGERback to summary
private static final Logger LOGGER
MAIN_FILE_DIRECTORYback to summary
public static final String MAIN_FILE_DIRECTORY
MAIN_FONT_SIZEback to summary
public static final String MAIN_FONT_SIZE
mainTableColumnPreferencesback to summary
private ColumnPreferences mainTableColumnPreferences
mainTablePreferencesback to summary
private MainTablePreferences mainTablePreferences
MEMORY_STICK_MODEback to summary
public static final String MEMORY_STICK_MODE
MERGE_APPLY_TO_ALL_ENTRIESback to summary
public static final String MERGE_APPLY_TO_ALL_ENTRIES
MERGE_ENTRIES_DIFF_MODEback to summary
public static final String MERGE_ENTRIES_DIFF_MODE
MERGE_ENTRIES_HIGHLIGHT_WORDSback to summary
public static final String MERGE_ENTRIES_HIGHLIGHT_WORDS
MERGE_ENTRIES_SHOULD_SHOW_DIFFback to summary
public static final String MERGE_ENTRIES_SHOULD_SHOW_DIFF
MERGE_ENTRIES_SHOULD_SHOW_UNIFIED_DIFFback to summary
public static final String MERGE_ENTRIES_SHOULD_SHOW_UNIFIED_DIFF
MERGE_SHOW_ONLY_CHANGED_FIELDSback to summary
public static final String MERGE_SHOW_ONLY_CHANGED_FIELDS
mergeDialogPreferencesback to summary
private MergeDialogPreferences mergeDialogPreferences
mrDlibPreferencesback to summary
private MrDlibPreferences mrDlibPreferences
NAME_FORMATER_KEYback to summary
public static final String NAME_FORMATER_KEY
NAME_FORMATTER_VALUEback to summary
public static final String NAME_FORMATTER_VALUE
nameDisplayPreferencesback to summary
private NameDisplayPreferences nameDisplayPreferences
nameFormatterPreferencesback to summary
private NameFormatterPreferences nameFormatterPreferences
NAMES_AS_ISback to summary
public static final String NAMES_AS_IS
NAMES_FIRST_LASTback to summary
public static final String NAMES_FIRST_LAST
NAMES_LAST_ONLYback to summary
public static final String NAMES_LAST_ONLY
NAMES_NATBIBback to summary
public static final String NAMES_NATBIB
NEWLINEback to summary
public static final String NEWLINE
NON_WRAPPABLE_FIELDSback to summary
public static final String NON_WRAPPABLE_FIELDS
OO_BIBLIOGRAPHY_STYLE_FILEback to summary
public static final String OO_BIBLIOGRAPHY_STYLE_FILE
OO_EXECUTABLE_PATHback to summary
public static final String OO_EXECUTABLE_PATH

The OpenOffice/LibreOffice connection preferences are: OO_PATH main directory for OO/LO installation, used to detect location on Win/macOS when using manual connect OO_EXECUTABLE_PATH path to soffice-file OO_JARS_PATH directory that contains juh.jar, jurt.jar, ridl.jar, unoil.jar OO_SYNC_WHEN_CITING true if the reference list is updated when adding a new citation OO_SHOW_PANEL true if the OO panel is shown on startup OO_USE_ALL_OPEN_DATABASES true if all databases should be used when citing OO_BIBLIOGRAPHY_STYLE_FILE path to the used style file OO_EXTERNAL_STYLE_FILES list with paths to external style files STYLES_*_* size and position of "Select style" dialog

OO_EXTERNAL_STYLE_FILESback to summary
public static final String OO_EXTERNAL_STYLE_FILES
OO_SHOW_PANELback to summary
public static final String OO_SHOW_PANEL
OO_SYNC_WHEN_CITINGback to summary
public static final String OO_SYNC_WHEN_CITING
OO_USE_ALL_OPEN_BASESback to summary
public static final String OO_USE_ALL_OPEN_BASES
OPEN_FOLDERS_OF_ATTACHED_FILESback to summary
public static final String OPEN_FOLDERS_OF_ATTACHED_FILES
OPEN_LAST_EDITEDback to summary
public static final String OPEN_LAST_EDITED
openOfficePreferencesback to summary
private OpenOfficePreferences openOfficePreferences
OVERRIDE_DEFAULT_FONT_SIZEback to summary
public static final String OVERRIDE_DEFAULT_FONT_SIZE
OVERWRITE_OWNERback to summary
public static final String OVERWRITE_OWNER
ownerPreferencesback to summary
private OwnerPreferences ownerPreferences
POS_Xback to summary
public static final String POS_X
POS_Yback to summary
public static final String POS_Y
prefsback to summary
private final Preferences prefs
PREFS_EXPORT_PATHback to summary
private static final String PREFS_EXPORT_PATH
PREFS_NODEback to summary
private static final Preferences PREFS_NODE
PREVIEW_AS_TABback to summary
public static final String PREVIEW_AS_TAB
PREVIEW_BST_LAYOUT_PATHSback to summary
public static final String PREVIEW_BST_LAYOUT_PATHS
PREVIEW_IN_ENTRY_TABLE_TOOLTIPback to summary
public static final String PREVIEW_IN_ENTRY_TABLE_TOOLTIP
PREVIEW_STYLEback to summary
public static final String PREVIEW_STYLE
previewPreferencesback to summary
private PreviewPreferences previewPreferences
PROTECTED_TERMS_DISABLED_EXTERNALback to summary
private static final String PROTECTED_TERMS_DISABLED_EXTERNAL
PROTECTED_TERMS_DISABLED_INTERNALback to summary
private static final String PROTECTED_TERMS_DISABLED_INTERNAL
PROTECTED_TERMS_ENABLED_EXTERNALback to summary
private static final String PROTECTED_TERMS_ENABLED_EXTERNAL
PROTECTED_TERMS_ENABLED_INTERNALback to summary
private static final String PROTECTED_TERMS_ENABLED_INTERNAL
protectedTermsPreferencesback to summary
private ProtectedTermsPreferences protectedTermsPreferences
PROXY_HOSTNAMEback to summary
private static final String PROXY_HOSTNAME
PROXY_PASSWORDback to summary
private static final String PROXY_PASSWORD
PROXY_PERSIST_PASSWORDback to summary
private static final String PROXY_PERSIST_PASSWORD
PROXY_PORTback to summary
private static final String PROXY_PORT
PROXY_USEback to summary
private static final String PROXY_USE
PROXY_USE_AUTHENTICATIONback to summary
private static final String PROXY_USE_AUTHENTICATION
PROXY_USERNAMEback to summary
private static final String PROXY_USERNAME
proxyPreferencesback to summary
private ProxyPreferences proxyPreferences
PUSH_EMACS_ADDITIONAL_PARAMETERSback to summary
public static final String PUSH_EMACS_ADDITIONAL_PARAMETERS
PUSH_EMACS_PATHback to summary
public static final String PUSH_EMACS_PATH
PUSH_LYXPIPEback to summary
public static final String PUSH_LYXPIPE
PUSH_SUBLIME_TEXT_PATHback to summary
public static final String PUSH_SUBLIME_TEXT_PATH
PUSH_TEXMAKER_PATHback to summary
public static final String PUSH_TEXMAKER_PATH
PUSH_TEXSTUDIO_PATHback to summary
public static final String PUSH_TEXSTUDIO_PATH
PUSH_TEXWORKS_PATHback to summary
public static final String PUSH_TEXWORKS_PATH
PUSH_TO_APPLICATIONback to summary
public static final String PUSH_TO_APPLICATION
PUSH_VIMback to summary
public static final String PUSH_VIM
PUSH_VIM_SERVERback to summary
public static final String PUSH_VIM_SERVER
PUSH_WINEDT_PATHback to summary
public static final String PUSH_WINEDT_PATH
pushToApplicationPreferencesback to summary
private PushToApplicationPreferences pushToApplicationPreferences
RECENT_DATABASESback to summary
public static final String RECENT_DATABASES
REFORMAT_FILE_ON_SAVE_AND_EXPORTback to summary
public static final String REFORMAT_FILE_ON_SAVE_AND_EXPORT
REMOTE_SERVER_PORTback to summary
private static final String REMOTE_SERVER_PORT
remotePreferencesback to summary
private RemotePreferences remotePreferences
RESOLVE_STRINGS_FOR_FIELDSback to summary
public static final String RESOLVE_STRINGS_FOR_FIELDS
SEARCH_CASE_SENSITIVEback to summary
public static final String SEARCH_CASE_SENSITIVE
SEARCH_CATALOGSback to summary
public static final String SEARCH_CATALOGS
SEARCH_DIALOG_COLUMN_SORT_ORDERback to summary
public static final String SEARCH_DIALOG_COLUMN_SORT_ORDER
SEARCH_DIALOG_COLUMN_SORT_TYPESback to summary
public static final String SEARCH_DIALOG_COLUMN_SORT_TYPES
SEARCH_DIALOG_COLUMN_WIDTHSback to summary
public static final String SEARCH_DIALOG_COLUMN_WIDTHS
SEARCH_DISPLAY_MODEback to summary
public static final String SEARCH_DISPLAY_MODE
SEARCH_FULLTEXTback to summary
public static final String SEARCH_FULLTEXT
SEARCH_KEEP_GLOBAL_WINDOW_ON_TOPback to summary
public static final String SEARCH_KEEP_GLOBAL_WINDOW_ON_TOP
SEARCH_KEEP_SEARCH_STRINGback to summary
public static final String SEARCH_KEEP_SEARCH_STRING
SEARCH_REG_EXPback to summary
public static final String SEARCH_REG_EXP
SEARCH_WINDOW_HEIGHTback to summary
public static final String SEARCH_WINDOW_HEIGHT
SEARCH_WINDOW_WIDTHback to summary
public static final String SEARCH_WINDOW_WIDTH
searchDialogColumnPreferencesback to summary
private ColumnPreferences searchDialogColumnPreferences
searchPreferencesback to summary
private SearchPreferences searchPreferences
SELECTED_FETCHER_INDEXback to summary
public static final String SELECTED_FETCHER_INDEX
SEND_LANGUAGE_DATAback to summary
public static final String SEND_LANGUAGE_DATA
SEND_OS_DATAback to summary
public static final String SEND_OS_DATA
SEND_TIMEZONE_DATAback to summary
public static final String SEND_TIMEZONE_DATA
SHOW_ADVANCED_HINTSback to summary
public static final String SHOW_ADVANCED_HINTS
SHOW_LATEX_CITATIONSback to summary
public static final String SHOW_LATEX_CITATIONS
SHOW_RECOMMENDATIONSback to summary
public static final String SHOW_RECOMMENDATIONS
SHOW_SCITE_TABback to summary
public static final String SHOW_SCITE_TAB
SHOW_USER_COMMENTS_FIELDSback to summary
public static final String SHOW_USER_COMMENTS_FIELDS
SIDE_PANE_COMPONENT_NAMESback to summary
public static final String SIDE_PANE_COMPONENT_NAMES
SIDE_PANE_COMPONENT_PREFERRED_POSITIONSback to summary
public static final String SIDE_PANE_COMPONENT_PREFERRED_POSITIONS
SIDE_PANE_WIDTHback to summary
public static final String SIDE_PANE_WIDTH
sidePanePreferencesback to summary
private SidePanePreferences sidePanePreferences
singletonback to summary
private static JabRefPreferences singleton
SIZE_Xback to summary
public static final String SIZE_X
SIZE_Yback to summary
public static final String SIZE_Y
SPECIALFIELDSENABLEDback to summary
public static final String SPECIALFIELDSENABLED
specialFieldsPreferencesback to summary
private SpecialFieldsPreferences specialFieldsPreferences
sslPreferencesback to summary
private SSLPreferences sslPreferences
STORE_RELATIVE_TO_BIBback to summary
public static final String STORE_RELATIVE_TO_BIB
STRINGLIST_DELIMITERback to summary
public static final Character STRINGLIST_DELIMITER
THEMEback to summary
public static final String THEME
THEME_SYNC_OSback to summary
public static final String THEME_SYNC_OS
TIME_STAMP_FIELDback to summary
public static final String TIME_STAMP_FIELD
TIME_STAMP_FORMATback to summary
public static final String TIME_STAMP_FORMAT
timestampPreferencesback to summary
private TimestampPreferences timestampPreferences
TRASH_INSTEAD_OF_DELETEback to summary
public static final String TRASH_INSTEAD_OF_DELETE
TRUSTSTORE_PATHback to summary
private static final String TRUSTSTORE_PATH
UNWANTED_CITATION_KEY_CHARACTERSback to summary
public static final String UNWANTED_CITATION_KEY_CHARACTERS
UPDATE_TIMESTAMPback to summary
public static final String UPDATE_TIMESTAMP
USE_AMS_FJOURNALback to summary
private static final String USE_AMS_FJOURNAL
USE_CUSTOM_DOI_URIback to summary
public static final String USE_CUSTOM_DOI_URI
USE_DEFAULT_CONSOLE_APPLICATIONback to summary
public static final String USE_DEFAULT_CONSOLE_APPLICATION
USE_DEFAULT_FILE_BROWSER_APPLICATIONback to summary
public static final String USE_DEFAULT_FILE_BROWSER_APPLICATION
USE_OWNERback to summary
public static final String USE_OWNER
USE_REMOTE_SERVERback to summary
private static final String USE_REMOTE_SERVER
USE_XMP_PRIVACY_FILTERback to summary
public static final String USE_XMP_PRIVACY_FILTER
USER_HOMEback to summary
private static final String USER_HOME
USER_IDback to summary
private static final String USER_ID
userAndHostback to summary
private String userAndHost

Cache variables

VALIDATE_IN_ENTRY_EDITORback to summary
public static final String VALIDATE_IN_ENTRY_EDITOR
VERSION_CHECK_ENABLEDback to summary
public static final String VERSION_CHECK_ENABLED
VERSION_IGNORED_UPDATEback to summary
public static final String VERSION_IGNORED_UPDATE
WARN_ABOUT_DUPLICATES_IN_INSPECTIONback to summary
public static final String WARN_ABOUT_DUPLICATES_IN_INSPECTION
WARN_BEFORE_OVERWRITING_KEYback to summary
public static final String WARN_BEFORE_OVERWRITING_KEY
WEB_SEARCH_VISIBLEback to summary
public static final String WEB_SEARCH_VISIBLE
WINDOW_FULLSCREENback to summary
public static final String WINDOW_FULLSCREEN
WINDOW_MAXIMISEDback to summary
public static final String WINDOW_MAXIMISED
WORKING_DIRECTORYback to summary
public static final String WORKING_DIRECTORY
workspacePreferencesback to summary
private WorkspacePreferences workspacePreferences
XMP_PRIVACY_FILTERSback to summary
public static final String XMP_PRIVACY_FILTERS
xmpPreferencesback to summary
private XmpPreferences xmpPreferences

Constructor Detail

JabRefPreferencesback to summary
private JabRefPreferences()

Method Detail

addPrefsRecursivelyback to summary
private void addPrefsRecursively(Preferences prefs, Map<String, Object> result) throws BackingStoreException
clearback to summary
public void clear() throws BackingStoreException

Implements org.jabref.preferences.PreferencesService.clear.

Clear all preferences.

Annotations
@Override
Exceptions
BackingStoreException:
if JabRef is unable to write to the registry/the preferences storage
clearAllBibEntryTypesback to summary
private void clearAllBibEntryTypes()
clearBibEntryTypesback to summary
private void clearBibEntryTypes(BibDatabaseMode mode)
clearCitationKeyPatternsback to summary
private void clearCitationKeyPatterns() throws BackingStoreException
clearCustomFetcherKeysback to summary
private void clearCustomFetcherKeys()
clearTruststoreFromCustomCertificatesback to summary
private void clearTruststoreFromCustomCertificates()
convertListToStringback to summary
pack-priv static String convertListToString(List<String> value)
Annotations
@VisibleForTesting
convertStringToListback to summary
pack-priv static List<String> convertStringToList(String toConvert)
Annotations
@VisibleForTesting
deleteKeyback to summary
public void deleteKey(String key) throws IllegalArgumentException

Implements org.jabref.preferences.PreferencesService.deleteKey.

Removes the given key from the preferences.

Annotations
@Override
Exceptions
IllegalArgumentException:
if the key does not exist
exportPreferencesback to summary
public void exportPreferences(Path path) throws JabRefException

Implements org.jabref.preferences.PreferencesService.exportPreferences.

Exports Preferences to an XML file.

Parameters
path:Path

Path to export to

Annotations
@Override
flushback to summary
public void flush()

Implements org.jabref.preferences.PreferencesService.flush.

Calling this method will write all preferences into the preference store.

Annotations
@Override
getback to summary
public String get(String key)
getback to summary
public String get(String key, String def)
getAsOptionalback to summary
public Optional<String> getAsOptional(String key)
getAutoCompletePreferencesback to summary
public AutoCompletePreferences getAutoCompletePreferences()

Implements org.jabref.preferences.PreferencesService.getAutoCompletePreferences.

Annotations
@Override
getAutoLinkKeyDependencyback to summary
private AutoLinkPreferences.CitationKeyDependency getAutoLinkKeyDependency()
getAutoLinkPreferencesback to summary
public AutoLinkPreferences getAutoLinkPreferences()

Implements org.jabref.preferences.PreferencesService.getAutoLinkPreferences.

Annotations
@Override
getBibEntryPreferencesback to summary
public BibEntryPreferences getBibEntryPreferences()

Implements org.jabref.preferences.PreferencesService.getBibEntryPreferences.

Annotations
@Override
getBibEntryTypesback to summary
private List<BibEntryType> getBibEntryTypes(BibDatabaseMode bibDatabaseMode)
getBooleanback to summary
public boolean getBoolean(String key)
getBooleanback to summary
public boolean getBoolean(String key, boolean def)
getBooleanDefaultback to summary
private boolean getBooleanDefault(String key)
getCitationKeyPatternPreferencesback to summary
public CitationKeyPatternPreferences getCitationKeyPatternPreferences()

Implements org.jabref.preferences.PreferencesService.getCitationKeyPatternPreferences.

Annotations
@Override
getCleanupPreferencesback to summary
public CleanupPreferences getCleanupPreferences()

Implements org.jabref.preferences.PreferencesService.getCleanupPreferences.

Annotations
@Override
getColumnNamesAsStringListback to summary
private static List<String> getColumnNamesAsStringList(ColumnPreferences columnPreferences)
getColumnsback to summary
private List<MainTableColumnModel> getColumns(String columnNamesList, String columnWidthList, String sortTypeList, double defaultWidth)
Annotations
@SuppressWarnings:SameParameterValue
getColumnSortOrderback to summary
private List<MainTableColumnModel> getColumnSortOrder(String sortOrderList, List<MainTableColumnModel> tableColumns)
getColumnSortOrderAsStringListback to summary
private static List<String> getColumnSortOrderAsStringList(ColumnPreferences columnPreferences)
getColumnSortTypesAsStringListback to summary
private static List<String> getColumnSortTypesAsStringList(ColumnPreferences columnPreferences)
getColumnWidthsAsStringListback to summary
private static List<String> getColumnWidthsAsStringList(ColumnPreferences columnPreferences)
getCustomEntryTypesRepositoryback to summary
public BibEntryTypesManager getCustomEntryTypesRepository()

Implements org.jabref.preferences.PreferencesService.getCustomEntryTypesRepository.

Annotations
@Override
getCustomExportFormatsback to summary
private List<TemplateExporter> getCustomExportFormats()
getCustomImportFormatsback to summary
private Set<CustomImporter> getCustomImportFormats()
getDefaultCleanupJobsback to summary
private static EnumSet<CleanupPreferences.CleanupStep> getDefaultCleanupJobs()
getDefaultCleanupPresetback to summary
public CleanupPreferences getDefaultCleanupPreset()

Implements org.jabref.preferences.PreferencesService.getDefaultCleanupPreset.

Annotations
@Override
getDefaultEntryEditorTabsback to summary
private SequencedMap<String, Set<Field>> getDefaultEntryEditorTabs()
getDefaultsback to summary
public Map<String, Object> getDefaults()

Implements org.jabref.preferences.PreferencesService.getDefaults.

Annotations
@Override
getDOIPreferencesback to summary
public DOIPreferences getDOIPreferences()

Implements org.jabref.preferences.PreferencesService.getDOIPreferences.

Annotations
@Override
getDoubleback to summary
public double getDouble(String key)
getDoubleDefaultback to summary
private double getDoubleDefault(String key)
getEmptyIsDefaultback to summary
public String getEmptyIsDefault(String key)
getEntryEditorPreferencesback to summary
public EntryEditorPreferences getEntryEditorPreferences()

Implements org.jabref.preferences.PreferencesService.getEntryEditorPreferences.

Annotations
@Override
getEntryEditorTabsback to summary
private Map<String, Set<Field>> getEntryEditorTabs()

Get a Map of defined tab names to default tab fields.

Returns:Map<String, Set<Field>>

A map of the currently defined tabs in the entry editor from scratch to cache

getExportPreferencesback to summary
public ExportPreferences getExportPreferences()

Implements org.jabref.preferences.PreferencesService.getExportPreferences.

Annotations
@Override
getExportSaveOrderback to summary
private SaveOrder getExportSaveOrder()
getExternalApplicationsPreferencesback to summary
public ExternalApplicationsPreferences getExternalApplicationsPreferences()

Implements org.jabref.preferences.PreferencesService.getExternalApplicationsPreferences.

Annotations
@Override
getFetcherKeysback to summary
private Set<FetcherApiKey> getFetcherKeys()
getFetcherKeysFromKeyringback to summary
private List<String> getFetcherKeysFromKeyring(List<String> names)
getFieldPreferencesback to summary
public FieldPreferences getFieldPreferences()

Implements org.jabref.preferences.PreferencesService.getFieldPreferences.

Annotations
@Override
getFileHistoryback to summary
private FileHistory getFileHistory()
getFilePreferencesback to summary
public FilePreferences getFilePreferences()

Implements org.jabref.preferences.PreferencesService.getFilePreferences.

Annotations
@Override
getGlobalCitationKeyPatternback to summary
private GlobalCitationKeyPatterns getGlobalCitationKeyPattern()
getGrobidPreferencesback to summary
public GrobidPreferences getGrobidPreferences()

Implements org.jabref.preferences.PreferencesService.getGrobidPreferences.

Annotations
@Override
getGroupsPreferencesback to summary
public GroupsPreferences getGroupsPreferences()

Implements org.jabref.preferences.PreferencesService.getGroupsPreferences.

Annotations
@Override
getGuiPreferencesback to summary
public GuiPreferences getGuiPreferences()

Implements org.jabref.preferences.PreferencesService.getGuiPreferences.

Annotations
@Override
getImporterPreferencesback to summary
public ImporterPreferences getImporterPreferences()

Implements org.jabref.preferences.PreferencesService.getImporterPreferences.

Annotations
@Override
getImportFormatPreferencesback to summary
public ImportFormatPreferences getImportFormatPreferences()

Implements org.jabref.preferences.PreferencesService.getImportFormatPreferences.

Annotations
@Override
getInstanceback to summary
public static JabRefPreferences getInstance()

Deprecated

Use PreferencesService instead

Returns:JabRefPreferences

Instance of JaRefPreferences

Annotations
@Deprecated
getIntback to summary
public int getInt(String key)
getIntDefaultback to summary
public int getIntDefault(String key)
getInternalPreferencesback to summary
public InternalPreferences getInternalPreferences()

Implements org.jabref.preferences.PreferencesService.getInternalPreferences.

Annotations
@Override
getJournalAbbreviationPreferencesback to summary
public JournalAbbreviationPreferences getJournalAbbreviationPreferences()

Implements org.jabref.preferences.PreferencesService.getJournalAbbreviationPreferences.

Annotations
@Override
getKeyBindingRepositoryback to summary
public KeyBindingRepository getKeyBindingRepository()

Implements org.jabref.preferences.PreferencesService.getKeyBindingRepository.

Annotations
@Override
getKeySuffixback to summary
private CitationKeyPatternPreferences.KeySuffix getKeySuffix()
getLanguageback to summary
private Language getLanguage()
getLayoutFormatterPreferencesback to summary
public LayoutFormatterPreferences getLayoutFormatterPreferences()

Implements org.jabref.preferences.PreferencesService.getLayoutFormatterPreferences.

Annotations
@Override
getLibraryPreferencesback to summary
public LibraryPreferences getLibraryPreferences()

Implements org.jabref.preferences.PreferencesService.getLibraryPreferences.

Annotations
@Override
getMainTableColumnPreferencesback to summary
public ColumnPreferences getMainTableColumnPreferences()

Implements org.jabref.preferences.PreferencesService.getMainTableColumnPreferences.

Annotations
@Override
getMainTablePreferencesback to summary
public MainTablePreferences getMainTablePreferences()

Implements org.jabref.preferences.PreferencesService.getMainTablePreferences.

Annotations
@Override
getMergeDialogPreferencesback to summary
public MergeDialogPreferences getMergeDialogPreferences()

Implements org.jabref.preferences.PreferencesService.getMergeDialogPreferences.

Annotations
@Override
getMrDlibPreferencesback to summary
public MrDlibPreferences getMrDlibPreferences()

Implements org.jabref.preferences.PreferencesService.getMrDlibPreferences.

Annotations
@Override
getNameAbbreviationStyleback to summary
private NameDisplayPreferences.AbbreviationStyle getNameAbbreviationStyle()
getNameDisplayPreferencesback to summary
public NameDisplayPreferences getNameDisplayPreferences()

Implements org.jabref.preferences.PreferencesService.getNameDisplayPreferences.

Annotations
@Override
getNameDisplayStyleback to summary
private NameDisplayPreferences.DisplayStyle getNameDisplayStyle()
getNameFormatterPreferencesback to summary
public NameFormatterPreferences getNameFormatterPreferences()

Implements org.jabref.preferences.PreferencesService.getNameFormatterPreferences.

Annotations
@Override
getObjectback to summary
private Object getObject(Preferences prefs, String key)
getOpenOfficePreferencesback to summary
public OpenOfficePreferences getOpenOfficePreferences()

Implements org.jabref.preferences.PreferencesService.getOpenOfficePreferences.

Annotations
@Override
getOwnerPreferencesback to summary
public OwnerPreferences getOwnerPreferences()

Implements org.jabref.preferences.PreferencesService.getOwnerPreferences.

Annotations
@Override
getPathback to summary
private Path getPath(String key, Path defaultValue)

Returns a Path

getPreferencesback to summary
public Map<String, Object> getPreferences()

Implements org.jabref.preferences.PreferencesService.getPreferences.

Annotations
@Override
getPrefsNodeForCustomizedEntryTypesback to summary
private static Preferences getPrefsNodeForCustomizedEntryTypes(BibDatabaseMode mode)
getPreviewCyclePositionback to summary
private int getPreviewCyclePosition(List<PreviewLayout> layouts)
getPreviewLayoutsback to summary
private List<PreviewLayout> getPreviewLayouts(String style)
getPreviewPreferencesback to summary
public PreviewPreferences getPreviewPreferences()

Implements org.jabref.preferences.PreferencesService.getPreviewPreferences.

Annotations
@Override
getProtectedTermsPreferencesback to summary
public ProtectedTermsPreferences getProtectedTermsPreferences()

Implements org.jabref.preferences.PreferencesService.getProtectedTermsPreferences.

Annotations
@Override
getProxyPasswordback to summary
private String getProxyPassword()
getProxyPreferencesback to summary
public ProxyPreferences getProxyPreferences()

Implements org.jabref.preferences.PreferencesService.getProxyPreferences.

Annotations
@Override
getPushToApplicationPreferencesback to summary
public PushToApplicationPreferences getPushToApplicationPreferences()

Implements org.jabref.preferences.PreferencesService.getPushToApplicationPreferences.

Annotations
@Override
getRemotePreferencesback to summary
public RemotePreferences getRemotePreferences()

Implements org.jabref.preferences.PreferencesService.getRemotePreferences.

Annotations
@Override
getSearchDialogColumnPreferencesback to summary
public ColumnPreferences getSearchDialogColumnPreferences()

Implements org.jabref.preferences.PreferencesService.getSearchDialogColumnPreferences.

Annotations
@Override
getSearchPreferencesback to summary
public SearchPreferences getSearchPreferences()

Implements org.jabref.preferences.PreferencesService.getSearchPreferences.

Annotations
@Override
getSelfContainedExportConfigurationback to summary
public SelfContainedSaveConfiguration getSelfContainedExportConfiguration()

Implements org.jabref.preferences.PreferencesService.getSelfContainedExportConfiguration.

Doc from org.jabref.preferences.PreferencesService.getSelfContainedExportConfiguration.

Returns the export configuration. The contained SaveConfiguration is a org.jabref.model.metadata.SelfContainedSaveOrder

Annotations
@Override
getSelfContainedTableSaveOrderback to summary
public SelfContainedSaveOrder getSelfContainedTableSaveOrder()

For the export configuration, generates the SelfContainedSaveOrder having the reference to TABLE resolved.

getSeriesback to summary
private List<String> getSeries(String key)

Returns a list of Strings stored by key+N with N being an incrementing number

getSidePanePreferencesback to summary
public SidePanePreferences getSidePanePreferences()

Implements org.jabref.preferences.PreferencesService.getSidePanePreferences.

Annotations
@Override
getSidePanePreferredPositionsback to summary
private Map<SidePaneType, Integer> getSidePanePreferredPositions()
getSpecialFieldsPreferencesback to summary
public SpecialFieldsPreferences getSpecialFieldsPreferences()

Implements org.jabref.preferences.PreferencesService.getSpecialFieldsPreferences.

Annotations
@Override
getSSLPreferencesback to summary
public SSLPreferences getSSLPreferences()

Implements org.jabref.preferences.PreferencesService.getSSLPreferences.

Annotations
@Override
getStringListback to summary
public List<String> getStringList(String key)

Returns a List of Strings containing the chosen columns.

getTimestampPreferencesback to summary
public TimestampPreferences getTimestampPreferences()

Implements org.jabref.preferences.PreferencesService.getTimestampPreferences.

Annotations
@Override
getUserAndHostback to summary
private String getUserAndHost()
getVisibleSidePanesback to summary
private Set<SidePaneType> getVisibleSidePanes()
getWorkspacePreferencesback to summary
public WorkspacePreferences getWorkspacePreferences()

Implements org.jabref.preferences.PreferencesService.getWorkspacePreferences.

Annotations
@Override
getXmpPreferencesback to summary
public XmpPreferences getXmpPreferences()

Implements org.jabref.preferences.PreferencesService.getXmpPreferences.

Annotations
@Override
hasKeyback to summary
public boolean hasKey(String key)

Check whether a key is set (differently from null).

Parameters
key:String

The key to check.

Returns:boolean

true if the key is set, false otherwise.

importPreferencesback to summary
public void importPreferences(Path file) throws JabRefException

Implements org.jabref.preferences.PreferencesService.importPreferences.

Imports Preferences from an XML file.

Parameters
file:Path

Path of file to import from

Annotations
@Override
Exceptions
JabRefException:
thrown if importing the preferences failed due to an InvalidPreferencesFormatException or an IOException
purgeSeriesback to summary
private void purgeSeries(String prefix, int number)

Removes all entries keyed by prefix+number, where number is equal to or higher than the given number.

Parameters
number:int

or higher.

putback to summary
public void put(String key, String value)
putBooleanback to summary
public void putBoolean(String key, boolean value)
putDoubleback to summary
public void putDouble(String key, double value)
putIntback to summary
public void putInt(String key, int value)
putIntback to summary
public void putInt(String key, Number value)
putStringListback to summary
public void putStringList(String key, List<String> value)

Puts a list of strings into the Preferences, by linking its elements with a STRINGLIST_DELIMITER into a single string. Escape characters make the process transparent even if strings contains a STRINGLIST_DELIMITER.

removeback to summary
private void remove(String key)
setLanguageDependentDefaultValuesback to summary
public void setLanguageDependentDefaultValues()
setProxyPasswordback to summary
private void setProxyPassword(String password)
storeBibEntryTypesback to summary
private void storeBibEntryTypes(Collection<BibEntryType> bibEntryTypes, BibDatabaseMode bibDatabaseMode)
storeBstPathsback to summary
private void storeBstPaths(List<Path> bstPaths)
storeCustomEntryTypesRepositoryback to summary
public void storeCustomEntryTypesRepository(BibEntryTypesManager entryTypesManager)

Implements org.jabref.preferences.PreferencesService.storeCustomEntryTypesRepository.

Annotations
@Override
storeCustomExportFormatsback to summary
private void storeCustomExportFormats(List<TemplateExporter> exporters)
storeCustomImportFormatsback to summary
private void storeCustomImportFormats(Set<CustomImporter> importers)
storeEntryEditorTabsback to summary
private void storeEntryEditorTabs(Map<String, Set<Field>> customTabs)

Stores the defined tabs and corresponding fields in the preferences.

Parameters
customTabs:Map<String, Set<Field>>

a map of tab names and the corresponding set of fields to be displayed in

storeExportSaveOrderback to summary
private void storeExportSaveOrder(SaveOrder saveOrder)
storeFetcherKeysback to summary
private void storeFetcherKeys(Set<FetcherApiKey> fetcherApiKeys)
storeFetcherKeysToKeyringback to summary
private void storeFetcherKeysToKeyring(List<String> names, List<String> keys)
storeFileHistoryback to summary
private void storeFileHistory(FileHistory history)
storeGlobalCitationKeyPatternback to summary
public void storeGlobalCitationKeyPattern(GlobalCitationKeyPatterns pattern)
storePreviewLayoutsback to summary
private void storePreviewLayouts(ObservableList<PreviewLayout> previewCycle)
storePushToApplicationPathback to summary
private void storePushToApplicationPath(Map<String, String> commandPair)
storeSidePanePreferredPositionsback to summary
private void storeSidePanePreferredPositions(Map<SidePaneType, Integer> preferredPositions)
storeVisibleSidePanesback to summary
private void storeVisibleSidePanes(Set<SidePaneType> visiblePanes)