org.jabref.logic.preview

public sealed Interface PreviewLayout

Known Direct Implementers: org.jabref.logic.preview.TextBasedPreviewLayout, org.jabref.logic.preview.BstPreviewLayout, org.jabref.logic.preview.CitationStylePreviewLayout
Imports: java.nio.file.Path, java.util.List, .Locale, org.jabref.logic.citationstyle.CSLStyleUtils, org.jabref.logic.journals.JournalAbbreviationRepository, org.jabref.logic.layout.LayoutFormatterPreferences, org.jabref.model.database.BibDatabaseContext, org.jabref.model.entry.BibEntry, .BibEntryTypesManager, org.jspecify.annotations.Nullable

Used for displaying a rendered entry in the UI. Due to historical reasons, "rendering" is called "layout".

Method Summary

Modifier and Type	Method and Description
public default boolean	containsCaseIndependent(String searchTerm)
public String	generatePreview(BibEntry entry, BibDatabaseContext databaseContext)
public String	getDisplayName()
public String	getName()
public String	getShortTitle()
public String	getText()
public static @Nullable PreviewLayout	of(String layout, String customPreviewLayout, List<Path> bstLayoutPaths, LayoutFormatterPreferences preferences, JournalAbbreviationRepository abbreviationRepository, BibEntryTypesManager entryTypesManager)

containsCaseIndependent	back to summary
public default boolean containsCaseIndependent(String searchTerm)

generatePreview	back to summary
public String generatePreview(BibEntry entry, BibDatabaseContext databaseContext)

getDisplayName	back to summary
public String getDisplayName()

getName	back to summary
public String getName()

getShortTitle	back to summary
public String getShortTitle()

getText	back to summary
public String getText()

of	back to summary
public static @Nullable PreviewLayout of(String layout, String customPreviewLayout, List<Path> bstLayoutPaths, LayoutFormatterPreferences preferences, JournalAbbreviationRepository abbreviationRepository, BibEntryTypesManager entryTypesManager)