JabRef 6.0-beta.1 · org.jabref.gui.theme.ThemePreset

A theme the user can select. Every theme, JabRef's own included, is maintained on https://themes.jabref.org/ and bundled by the build from the jabgui/src/main/themes.jabref.org submodule (see processResources in jabgui/build.gradle.kts); the JabRef repository holds no theme of its own, only the base stylesheet that reads the tokens.

The constants are a hand-maintained mirror of that submodule -- ThemePresetTest fails when the two drift apart -- so that the set of themes is fixed at compile time and no classpath scanning happens at startup. The JabRef and Primer themes declare the complete -color-* token contract and have no parent; the other themes only override what differs from their getParent(), the JabRef theme, which ThemeManager installs beneath them.

impl->req~ux.themes.bundled-community-themes~1

Field Summary

Modifier and Type	Field and Description
private final String	bothNames
public static final ThemePreset	CHOCOLATE_HONEY
private final String	css
private final String	darkName
public static final ThemePreset	DINOGIRLS_CHOCOLATEBROWN
public static final ThemePreset	DINOGIRLS_FUCHSIAPURPLE
public static final ThemePreset	DINOGIRLS_LIGHTBLUE
public static final ThemePreset	DINOGIRLS_LIGHTSEAGREEN
public static final ThemePreset	DINOGIRLS_PREHISTORICAMBER
public static final ThemePreset	DINOGIRLS_TWILIGHTLAVENDER
public static final ThemePreset	DINOGIRLS_WINERED
public static final ThemePreset	EVERFOREST
public static final ThemePreset	JABREF
private final String	lightName
public static final ThemePreset	NORD
public static final ThemePreset	PAPERS
private final @Nullable ThemePreset	parent
public static final ThemePreset	PRIMER
private StyleSheet	styleSheet

Constructor Summary

Access	Constructor and Description
private	ThemePreset(String themeName, String css, @Nullable ThemePreset the theme this one only overrides tokens of, `null` for a theme declaring the complete token contract parent)
private	ThemePreset(String collection, String darkHue, String lightHue, String css, @Nullable ThemePreset parent) Dino Girl published her dark and light hues as separate themes; the port pairs each dark hue with the closest light one in a single file, so such a theme carries one name per color scheme.

Method Summary

Modifier and Type	Method and Description
public String	getLocalizedName() Both names of a paired theme, e.g. for lists that are not tied to a color scheme.
public String	getLocalizedName(@Nullable ThemeColorScheme the scheme the theme is shown in; an unset one is read as `ThemeColorScheme#FOLLOW_SYSTEM`, as everywhere else colorScheme) The name matching the color scheme the user would see the theme in; when following the system, both hues are shown as "dark / light".
public Optional<ThemePreset>	getParent() The theme whose stylesheet is installed beneath this one, so that the tokens this theme does not declare come from there.
public String	getPreferenceName()
public Optional<URL>	getPreview(ThemeColorScheme colorScheme) The bundled screenshot of this theme in the given color scheme, scaled to preview size by the build (`generateThemePreviews` in `jabgui/build.gradle.kts`).
public StyleSheet	getStyleSheet()
public static ThemePreset	of(String themePreset)
public static ThemePreset	valueOf(String name)
public static ThemePreset[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

bothNames	back to summary
private final String bothNames

CHOCOLATE_HONEY	back to summary
public static final ThemePreset CHOCOLATE_HONEY

css	back to summary
private final String css

darkName	back to summary
private final String darkName

DINOGIRLS_CHOCOLATEBROWN	back to summary
public static final ThemePreset DINOGIRLS_CHOCOLATEBROWN

DINOGIRLS_FUCHSIAPURPLE	back to summary
public static final ThemePreset DINOGIRLS_FUCHSIAPURPLE

DINOGIRLS_LIGHTBLUE	back to summary
public static final ThemePreset DINOGIRLS_LIGHTBLUE

DINOGIRLS_LIGHTSEAGREEN	back to summary
public static final ThemePreset DINOGIRLS_LIGHTSEAGREEN

DINOGIRLS_PREHISTORICAMBER	back to summary
public static final ThemePreset DINOGIRLS_PREHISTORICAMBER

DINOGIRLS_TWILIGHTLAVENDER	back to summary
public static final ThemePreset DINOGIRLS_TWILIGHTLAVENDER

DINOGIRLS_WINERED	back to summary
public static final ThemePreset DINOGIRLS_WINERED

EVERFOREST	back to summary
public static final ThemePreset EVERFOREST

JABREF	back to summary
public static final ThemePreset JABREF

lightName	back to summary
private final String lightName

NORD	back to summary
public static final ThemePreset NORD

PAPERS	back to summary
public static final ThemePreset PAPERS

parent	back to summary
private final @Nullable ThemePreset parent

PRIMER	back to summary
public static final ThemePreset PRIMER

styleSheet	back to summary
private StyleSheet styleSheet

Constructor Detail

ThemePreset	back to summary
private ThemePreset(String themeName, String css, @Nullable ThemePreset parent) Parameters parent:@Nullable ThemePreset the theme this one only overrides tokens of, `null` for a theme declaring the complete token contract

ThemePreset	back to summary
private ThemePreset(String collection, String darkHue, String lightHue, String css, @Nullable ThemePreset parent) Dino Girl published her dark and light hues as separate themes; the port pairs each dark hue with the closest light one in a single file, so such a theme carries one name per color scheme. Community theme names are proper nouns and stay untranslated.

Method Detail

getLocalizedName	back to summary
public String getLocalizedName() Both names of a paired theme, e.g. for lists that are not tied to a color scheme.

getLocalizedName back to summary

getLocalizedName	back to summary
public String getLocalizedName(@Nullable ThemeColorScheme colorScheme) The name matching the color scheme the user would see the theme in; when following the system, both hues are shown as "dark / light". Parameters colorScheme:@Nullable ThemeColorScheme the scheme the theme is shown in; an unset one is read as `ThemeColorScheme#FOLLOW_SYSTEM`, as everywhere else

public String getLocalizedName(@Nullable ThemeColorScheme colorScheme)

The name matching the color scheme the user would see the theme in; when following the system, both hues are shown as "dark / light".

Parameters

colorScheme:@Nullable ThemeColorScheme: the scheme the theme is shown in; an unset one is read as ThemeColorScheme#FOLLOW_SYSTEM, as everywhere else

getParent	back to summary
public Optional<ThemePreset> getParent() The theme whose stylesheet is installed beneath this one, so that the tokens this theme does not declare come from there. Empty for the JabRef and Primer themes, which declare every token.

getPreferenceName	back to summary
public String getPreferenceName()

getPreview	back to summary
public Optional<URL> getPreview(ThemeColorScheme colorScheme) The bundled screenshot of this theme in the given color scheme, scaled to preview size by the build (`generateThemePreviews` in `jabgui/build.gradle.kts`). Following the system yields the dark one.

getStyleSheet	back to summary
public StyleSheet getStyleSheet()

of	back to summary
public static ThemePreset of(String themePreset)

valueOf	back to summary
public static ThemePreset valueOf(String name)