Modifier and Type	Class and Description
public static enum	EntryEditorTabModel.BuiltIn Every fixed tab in the entry editor, in display order.
public static record	EntryEditorTabModel.BuiltInTab
public static record	EntryEditorTabModel.CustomizedFieldsTab A user-defined tab showing an explicit, ordered list of field patterns.

Modifier and Type	Method and Description
public static Set<Field>	extractedFieldsOnCustomTabs(List<EntryEditorTabModel> tabModels, BibEntry entry) Union of the fields resolved by all `CustomizedFieldsTab`s' extracted patterns in the given tab list.
public default boolean	isPreview()
public boolean	isVisible()
public EntryEditorTabModel	withVisible(boolean visible)

extractedFieldsOnCustomTabs	back to summary
public static Set<Field> extractedFieldsOnCustomTabs(List<EntryEditorTabModel> tabModels, BibEntry entry) Union of the fields resolved by all `CustomizedFieldsTab`s' extracted patterns in the given tab list. An extracted field is moved to its custom tab: the Main tab uses this to exclude it from its field list and add-chips, so no field is displayed twice. Non-extracted patterns (the default) leave the Main tab untouched.

isPreview	back to summary
public default boolean isPreview()

isVisible	back to summary
public boolean isVisible()

withVisible	back to summary
public EntryEditorTabModel withVisible(boolean visible)

org.jabref.gui.entryeditor back to summary

public final Enum EntryEditorTabModel.BuiltIn

Class Inheritance

extends Enum<EntryEditorTabModel.BuiltIn>

java.lang.Object
java.lang.Enum
org.jabref.gui.entryeditor.EntryEditorTabModel.BuiltIn

Every fixed tab in the entry editor, in display order.

Field Summary

Modifier and Type	Field and Description
public static final EntryEditorTabModel.BuiltIn	AI_CHAT
public static final EntryEditorTabModel.BuiltIn	AI_SUMMARY
public static final EntryEditorTabModel.BuiltIn	ALL_FIELDS
public static final EntryEditorTabModel.BuiltIn	CITATION_INFORMATION
private static final Set<EntryEditorTabModel.BuiltIn>	FIELD_SETS
public static final EntryEditorTabModel.BuiltIn	FILE_ANNOTATIONS
public static final EntryEditorTabModel.BuiltIn	FULLTEXT_SEARCH_RESULTS
public static final EntryEditorTabModel.BuiltIn	LATEX_CITATIONS
public static final EntryEditorTabModel.BuiltIn	PREVIEW
public static final EntryEditorTabModel.BuiltIn	RELATED_ARTICLES
public static final EntryEditorTabModel.BuiltIn	SOURCE

Constructor Summary

Access	Constructor and Description
private	BuiltIn()

Method Summary

Modifier and Type	Method and Description
public String	displayName()
public boolean	isFieldSet()
public static EntryEditorTabModel.BuiltIn	valueOf(String name)
public static EntryEditorTabModel.BuiltIn[]	values()

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

Field Detail

AI_CHAT	back to summary
public static final EntryEditorTabModel.BuiltIn AI_CHAT

AI_SUMMARY	back to summary
public static final EntryEditorTabModel.BuiltIn AI_SUMMARY

ALL_FIELDS	back to summary
public static final EntryEditorTabModel.BuiltIn ALL_FIELDS

CITATION_INFORMATION	back to summary
public static final EntryEditorTabModel.BuiltIn CITATION_INFORMATION

FIELD_SETS	back to summary
private static final Set<EntryEditorTabModel.BuiltIn> FIELD_SETS

FILE_ANNOTATIONS	back to summary
public static final EntryEditorTabModel.BuiltIn FILE_ANNOTATIONS

FULLTEXT_SEARCH_RESULTS	back to summary
public static final EntryEditorTabModel.BuiltIn FULLTEXT_SEARCH_RESULTS

LATEX_CITATIONS	back to summary
public static final EntryEditorTabModel.BuiltIn LATEX_CITATIONS

PREVIEW	back to summary
public static final EntryEditorTabModel.BuiltIn PREVIEW

RELATED_ARTICLES	back to summary
public static final EntryEditorTabModel.BuiltIn RELATED_ARTICLES

SOURCE	back to summary
public static final EntryEditorTabModel.BuiltIn SOURCE

Constructor Detail

BuiltIn	back to summary
private BuiltIn()

Method Detail

displayName	back to summary
public String displayName()

isFieldSet	back to summary
public boolean isFieldSet()

valueOf	back to summary
public static EntryEditorTabModel.BuiltIn valueOf(String name)

values	back to summary
public static EntryEditorTabModel.BuiltIn[] values()

org.jabref.gui.entryeditor back to summary

public final Record EntryEditorTabModel.BuiltInTab

Class Inheritance

extends Record
implements EntryEditorTabModel

java.lang.Object
java.lang.Record
org.jabref.gui.entryeditor.EntryEditorTabModel.BuiltInTab

All Implemented Interfaces

org.jabref.gui.entryeditor.EntryEditorTabModel

Record Components

type:EntryEditorTabModel.BuiltIn
visible:boolean

Field Summary

Modifier and Type	Field and Description
private final EntryEditorTabModel.BuiltIn	type Record Component accessed by type().
private final boolean	visible Record Component accessed by visible().

Constructor Summary

Access	Constructor and Description
public	BuiltInTab(EntryEditorTabModel.BuiltIn type, boolean visible)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public boolean	isVisible() Implements org.jabref.gui.entryeditor.EntryEditorTabModel.isVisible.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public EntryEditorTabModel.BuiltIn	type() Record Component getter of type.
public boolean	visible() Record Component getter of visible.
public EntryEditorTabModel	withVisible(boolean visible) Implements org.jabref.gui.entryeditor.EntryEditorTabModel.withVisible.

Field Detail

type	back to summary
private final EntryEditorTabModel.BuiltIn type Record Component accessed by type().

visible	back to summary
private final boolean visible Record Component accessed by visible().

Constructor Detail

BuiltInTab	back to summary
public BuiltInTab(EntryEditorTabModel.BuiltIn type, boolean visible)

Method Detail

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

isVisible	back to summary
public boolean isVisible() Implements org.jabref.gui.entryeditor.EntryEditorTabModel.isVisible. Annotations @Override

isVisible

back to summary

public boolean isVisible()

Implements org.jabref.gui.entryeditor.EntryEditorTabModel.isVisible.

Annotations

@Override

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

type	back to summary
public EntryEditorTabModel.BuiltIn type() Record Component getter of type.

visible	back to summary
public boolean visible() Record Component getter of visible.

withVisible	back to summary
public EntryEditorTabModel withVisible(boolean visible) Implements org.jabref.gui.entryeditor.EntryEditorTabModel.withVisible. Annotations @Override

withVisible

back to summary

public EntryEditorTabModel withVisible(boolean visible)

Implements org.jabref.gui.entryeditor.EntryEditorTabModel.withVisible.

Annotations

@Override

org.jabref.gui.entryeditor back to summary

public final Record EntryEditorTabModel.CustomizedFieldsTab

Class Inheritance

extends Record
implements EntryEditorTabModel

java.lang.Object
java.lang.Record
org.jabref.gui.entryeditor.EntryEditorTabModel.CustomizedFieldsTab

All Implemented Interfaces

org.jabref.gui.entryeditor.EntryEditorTabModel

Record Components

name:String
fieldPatterns:List<String>
extractedFieldPatterns:Set<String>

A user-defined tab showing an explicit, ordered list of field patterns. Always shown while its pattern list resolves to at least one field; toggled only by being added to or removed from the tab list, so it carries no visibility flag (unlike BuiltInTab).

A pattern is either a plain field name (always shown, even while unset on the entry) or a regular expression (contains regex metacharacters), which captures every set field of the entry whose name matches it — e.g. comment-.* for all user-specific comment fields.

A pattern in extractedFieldPatterns is additionally extracted: the fields it resolves to leave the Main tab. Patterns are not extracted by default, so a custom tab initially only mirrors its fields.

Field Summary

Modifier and Type	Field and Description
private static final Map<String, Optional<Pattern>>	COMPILED_REGEXES See `compiledRegex`; empty marks an invalid regex.
private final Set<String>	extractedFieldPatterns Record Component accessed by extractedFieldPatterns().
private final List<String>	fieldPatterns Record Component accessed by fieldPatterns().
private static final Set<String>	KNOWN_FIELD_NAMES Lower-cased names of every registered field (see `appearsOnMainTab`).
private final String	name Record Component accessed by name().
private static final Pattern	PLAIN_FIELD_NAME A pattern without any regex metacharacter is a plain field name.

Constructor Summary

Access	Constructor and Description
public	CustomizedFieldsTab(String name, List<String> fieldPatterns, Set<String> extractedFieldPatterns)
public	CustomizedFieldsTab(String name, List<String> fieldPatterns) A tab with no extracted patterns (the default for newly configured fields).

Method Summary

Modifier and Type	Method and Description
public static boolean	appearsOnMainTab(String fieldPattern) Whether the "Extract field" choice applies to the pattern: only a plain name of a known field is a field the Main tab shows on its own.
private static Optional<Pattern>	compiledRegex(String pattern) Regex patterns are resolved on every Main-tab and custom-tab rebuild, so the compiled form is cached (the cache stays small: it only ever holds the user's configured patterns).
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public Set<String>	extractedFieldPatterns() Record Component getter of extractedFieldPatterns.
public List<String>	fieldPatterns() Record Component getter of fieldPatterns.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public boolean	isVisible() Implements org.jabref.gui.entryeditor.EntryEditorTabModel.isVisible.
public String	name() Record Component getter of name.
private SequencedSet<Field>	resolve(List<String> patterns, BibEntry entry)
public SequencedSet<Field>	resolveExtractedFields(BibEntry entry) Resolves only the extracted patterns — the fields the Main tab must no longer show.
public SequencedSet<Field>	resolveFields(BibEntry entry) Resolves `fieldPatterns` against the given entry, keeping the configured pattern order; the fields captured by one regex pattern are sorted by name.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public EntryEditorTabModel	withVisible(boolean visible) Implements org.jabref.gui.entryeditor.EntryEditorTabModel.withVisible.

Field Detail

COMPILED_REGEXES	back to summary
private static final Map<String, Optional<Pattern>> COMPILED_REGEXES See `compiledRegex`; empty marks an invalid regex.

extractedFieldPatterns	back to summary
private final Set<String> extractedFieldPatterns Record Component accessed by extractedFieldPatterns().

fieldPatterns	back to summary
private final List<String> fieldPatterns Record Component accessed by fieldPatterns().

KNOWN_FIELD_NAMES	back to summary
private static final Set<String> KNOWN_FIELD_NAMES Lower-cased names of every registered field (see `appearsOnMainTab`).

name	back to summary
private final String name Record Component accessed by name().

PLAIN_FIELD_NAME	back to summary
private static final Pattern PLAIN_FIELD_NAME A pattern without any regex metacharacter is a plain field name.

Constructor Detail

CustomizedFieldsTab	back to summary
public CustomizedFieldsTab(String name, List<String> fieldPatterns, Set<String> extractedFieldPatterns)

CustomizedFieldsTab	back to summary
public CustomizedFieldsTab(String name, List<String> fieldPatterns) A tab with no extracted patterns (the default for newly configured fields).

Method Detail

appearsOnMainTab back to summary

appearsOnMainTab	back to summary
public static boolean appearsOnMainTab(String fieldPattern) Whether the "Extract field" choice applies to the pattern: only a plain name of a known field is a field the Main tab shows on its own. A regex pattern or an unknown field name is always extracted — the custom tab is the only place curating such fields — so the preferences UI shows its checkbox checked and disabled. Checked against the catalog of all registered fields, not via a type-less `FieldFactory#parseField(String)`: type-scoped BibLaTeX software/APA fields (`license`, `article`, …) parse as unknown without an entry type but are known fields nonetheless.

public static boolean appearsOnMainTab(String fieldPattern)

Whether the "Extract field" choice applies to the pattern: only a plain name of a known field is a field the Main tab shows on its own. A regex pattern or an unknown field name is always extracted — the custom tab is the only place curating such fields — so the preferences UI shows its checkbox checked and disabled.

Checked against the catalog of all registered fields, not via a type-less FieldFactory#parseField(String): type-scoped BibLaTeX software/APA fields (license, article, …) parse as unknown without an entry type but are known fields nonetheless.

compiledRegex	back to summary
private static Optional<Pattern> compiledRegex(String pattern) Regex patterns are resolved on every Main-tab and custom-tab rebuild, so the compiled form is cached (the cache stays small: it only ever holds the user's configured patterns).

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

extractedFieldPatterns	back to summary
public Set<String> extractedFieldPatterns() Record Component getter of extractedFieldPatterns.

fieldPatterns	back to summary
public List<String> fieldPatterns() Record Component getter of fieldPatterns.

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

isVisible

back to summary

public boolean isVisible()

Implements org.jabref.gui.entryeditor.EntryEditorTabModel.isVisible.

Annotations

@Override

name	back to summary
public String name() Record Component getter of name.

resolve	back to summary
private SequencedSet<Field> resolve(List<String> patterns, BibEntry entry)

resolveExtractedFields	back to summary
public SequencedSet<Field> resolveExtractedFields(BibEntry entry) Resolves only the extracted patterns — the fields the Main tab must no longer show.

resolveFields	back to summary
public SequencedSet<Field> resolveFields(BibEntry entry) Resolves `fieldPatterns` against the given entry, keeping the configured pattern order; the fields captured by one regex pattern are sorted by name. Invalid regexes resolve to nothing.

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

withVisible

back to summary

public EntryEditorTabModel withVisible(boolean visible)

Implements org.jabref.gui.entryeditor.EntryEditorTabModel.withVisible.

Annotations

@Override

public sealed Interface EntryEditorTabModel

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum EntryEditorTabModel.BuiltIn

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Record EntryEditorTabModel.BuiltInTab

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Record EntryEditorTabModel.CustomizedFieldsTab

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail