Top Description Methods
org.jabref.gui.preferences

public Interface PreferencesTab

Known Direct Implementers
org.jabref.gui.preferences.autocompletion.AutoCompletionTab, org.jabref.gui.preferences.citationkeypattern.CitationKeyPatternTab, org.jabref.gui.preferences.customentrytypes.CustomEntryTypesTab, org.jabref.gui.preferences.customexporter.CustomExporterTab, org.jabref.gui.preferences.customimporter.CustomImporterTab, org.jabref.gui.preferences.entry.EntryTab, org.jabref.gui.preferences.entryeditor.EntryEditorTab, org.jabref.gui.preferences.export.ExportTab, org.jabref.gui.preferences.external.ExternalTab, org.jabref.gui.preferences.externalfiletypes.ExternalFileTypesTab, org.jabref.gui.preferences.general.GeneralTab, org.jabref.gui.preferences.groups.GroupsTab, org.jabref.gui.preferences.journals.JournalAbbreviationsTab, org.jabref.gui.preferences.keybindings.KeyBindingsTab, org.jabref.gui.preferences.linkedfiles.LinkedFilesTab, org.jabref.gui.preferences.nameformatter.NameFormatterTab, org.jabref.gui.preferences.network.NetworkTab, org.jabref.gui.preferences.preview.PreviewTab, org.jabref.gui.preferences.protectedterms.ProtectedTermsTab, org.jabref.gui.preferences.table.TableTab, org.jabref.gui.preferences.websearch.WebSearchTab, org.jabref.gui.preferences.xmp.XmpPrivacyTab, org.jabref.gui.preferences.AbstractPreferenceTabView
Imports
java.util.List, javafx.scene.Node

A prefsTab is a component displayed in the PreferenceDialog.

It needs to extend from Component.

Method Summary

Modifier and TypeMethod and Description
public Node
public List<String>

Returns:

The messages for the changed properties (e. g. "Changed language: English")
getRestartWarnings
()

This method should be called after storing the preferences, This calls the appropriate method in the ViewModel.

public String

Returns:

Identifier for the tab (for instance "General", "Appearance" or "External Files").
getTabName
()

Should return the localized identifier to use for the tab.

public void
setValues()

This method is called when the dialog is opened, or if it is made visible after being hidden.

public void
storeSettings()

This method is called when the user presses OK in the Preferences dialog.

public boolean
validateSettings()

This method is called before the storeSettings() method, to check if there are illegal settings in the tab, or if is ready to be closed.

Method Detail

getBuilderback to summary
public Node getBuilder()
getRestartWarningsback to summary
public List<String> getRestartWarnings()

This method should be called after storing the preferences, This calls the appropriate method in the ViewModel.

Returns:List<String>

The messages for the changed properties (e. g. "Changed language: English")

getTabNameback to summary
public String getTabName()

Should return the localized identifier to use for the tab.

Returns:String

Identifier for the tab (for instance "General", "Appearance" or "External Files").

setValuesback to summary
public void setValues()

This method is called when the dialog is opened, or if it is made visible after being hidden. This calls the appropriate method in the ViewModel.

storeSettingsback to summary
public void storeSettings()

This method is called when the user presses OK in the Preferences dialog. This calls the appropriate method in the ViewModel.

validateSettingsback to summary
public boolean validateSettings()

This method is called before the storeSettings() method, to check if there are illegal settings in the tab, or if is ready to be closed. This calls the appropriate method in the ViewModel.