Top Description Inners Fields Constructors Methods
org.jabref.gui.theme

public Class Theme

extends Object
Class Inheritance
Imports
java.util.Objects, .Optional

Represents one of three types of a css based Theme for JabRef:

The Default type of theme is the light theme (which is in fact the absence of any theme), the dark theme is currently the only embedded theme and the custom themes, that can be created by loading a proper css file.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum

Field Summary

Modifier and TypeField and Description
private final Optional<StyleSheet>
public static final String
public static final String
private final String
private final Theme.Type

Constructor Summary

AccessConstructor and Description
public
Theme(String name)

Method Summary

Modifier and TypeMethod and Description
public static Theme
custom(String name)

public static Theme
dark()

public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public Optional<StyleSheet>

Returns:

called with the stylesheet location if there is an additional stylesheet present and available. The location will be a local URL. Typically it will be a 'data:' URL where the CSS is embedded. However for large themes it can be 'file:'.
getAdditionalStylesheet
()

This method allows callers to obtain the theme's additional stylesheet.

public String

Returns:

the raw configured CSS location. Guaranteed to be non-null.
getName
()

Provides the name of the CSS, either for a built in theme, or for a raw, configured custom CSS location.

public Theme.Type

Returns:

the Theme type. Guaranteed to be non-null.
getType
()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public static Theme
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

additionalStylesheetback to summary
private final Optional<StyleSheet> additionalStylesheet
BASE_CSSback to summary
public static final String BASE_CSS
EMBEDDED_DARK_CSSback to summary
public static final String EMBEDDED_DARK_CSS
nameback to summary
private final String name
typeback to summary
private final Theme.Type type

Constructor Detail

Themeback to summary
public Theme(String name)

Method Detail

customback to summary
public static Theme custom(String name)
darkback to summary
public static Theme dark()
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getAdditionalStylesheetback to summary
public Optional<StyleSheet> getAdditionalStylesheet()

This method allows callers to obtain the theme's additional stylesheet.

Returns:Optional<StyleSheet>

called with the stylesheet location if there is an additional stylesheet present and available. The location will be a local URL. Typically it will be a 'data:' URL where the CSS is embedded. However for large themes it can be 'file:'.

getNameback to summary
public String getName()

Provides the name of the CSS, either for a built in theme, or for a raw, configured custom CSS location. This should be a file system path, but the raw string is returned even if it is not valid in some way. For this reason, the main use case for this getter is to storing or display the user preference, rather than to read and use the CSS file.

Returns:String

the raw configured CSS location. Guaranteed to be non-null.

getTypeback to summary
public Theme.Type getType()
Returns:Theme.Type

the Theme type. Guaranteed to be non-null.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
lightback to summary
public static Theme light()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
org.jabref.gui.theme back to summary

public final Enum Theme.Type

extends Enum<Theme.Type>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final Theme.Type
public static final Theme.Type
public static final Theme.Type

Constructor Summary

AccessConstructor and Description
private
Type()

Method Summary

Modifier and TypeMethod and Description
public static Theme.Type
public static Theme.Type[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CUSTOMback to summary
public static final Theme.Type CUSTOM
DEFAULTback to summary
public static final Theme.Type DEFAULT
EMBEDDEDback to summary
public static final Theme.Type EMBEDDED

Constructor Detail

Typeback to summary
private Type()

Method Detail

valueOfback to summary
public static Theme.Type valueOf(String name)
valuesback to summary
public static Theme.Type[] values()