Verified Owner
Top Description Methods
org.jabref.gui.preferences

public Interface PreferencesTab

Known Direct Implementers
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
getContent()

Returns: the root node of the tab's content, shown in the preferences dialog

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 default List<SearchableElement>
getSearchableElements()

The visible texts of the tab with the nodes they caption; the preferences search matches these and highlights the node.

public default List<String>
getSearchKeywords()

Extra, invisible search terms for the tab (synonyms, abbreviations).

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 default String
getTitle()

The heading the dialog shows above the tab's content.

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

getContentback to summary
public Node getContent()
Returns:Node

the root node of the tab's content, shown in the preferences dialog

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")

getSearchableElementsback to summary
public default List<SearchableElement> getSearchableElements()

The visible texts of the tab with the nodes they caption; the preferences search matches these and highlights the node.

getSearchKeywordsback to summary
public default List<String> getSearchKeywords()

Extra, invisible search terms for the tab (synonyms, abbreviations). The visible texts are covered by getSearchableElements() already.

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").

getTitleback to summary
public default String getTitle()

The heading the dialog shows above the tab's content. Defaults to the tab's name; override where the heading is more specific (e.g. tab "Entry types", heading "Custom entry types").

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.