Verified Owner
Top Description Fields Constructors Methods
org.jabref.logic.preview

public final Class TextBasedPreviewLayout

extends Object
implements PreviewLayout
Class Inheritance
All Implemented Interfaces
org.jabref.logic.preview.PreviewLayout
Imports
java.io.IOException, .Reader, org.jabref.logic.journals.JournalAbbreviationRepository, org.jabref.logic.l10n.Localization, org.jabref.logic.layout.Layout, .LayoutFormatterPreferences, .LayoutHelper, org.jabref.model.database.BibDatabaseContext, org.jabref.model.entry.BibEntry, org.jspecify.annotations.NonNull, org.slf4j.Logger, .LoggerFactory
Implements the preview based JabRef's Custom export filters. Caching supports only one instance

Field Summary

Modifier and TypeField and Description
private JournalAbbreviationRepository
abbreviationRepository

public static final String
DEFAULT

private Layout
layout

private LayoutFormatterPreferences
layoutFormatterPreferences

private static final Logger
LOGGER

public static final String
NAME

private String
text

Constructor Summary

AccessConstructor and Description
public
TextBasedPreviewLayout(String text, @NonNull LayoutFormatterPreferences layoutFormatterPreferences, @NonNull JournalAbbreviationRepository abbreviationRepository)

public
TextBasedPreviewLayout(Layout layout)

Method Summary

Modifier and TypeMethod and Description
public String
generatePreview(BibEntry entry, BibDatabaseContext databaseContext)

Implements org.jabref.logic.preview.PreviewLayout.generatePreview.

public String
getDisplayName()

Implements org.jabref.logic.preview.PreviewLayout.getDisplayName.

public String
getName()

Implements org.jabref.logic.preview.PreviewLayout.getName.

public String
getShortTitle()

Implements org.jabref.logic.preview.PreviewLayout.getShortTitle.

public String
getText()

Implements org.jabref.logic.preview.PreviewLayout.getText.

public static TextBasedPreviewLayout
of(@NonNull String style, @NonNull LayoutFormatterPreferences layoutFormatterPreferences, @NonNull JournalAbbreviationRepository abbreviationRepository)

public void
setText(String text)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

abbreviationRepositoryback to summary
private JournalAbbreviationRepository abbreviationRepository
DEFAULTback to summary
public static final String DEFAULT
layoutback to summary
private Layout layout
layoutFormatterPreferencesback to summary
private LayoutFormatterPreferences layoutFormatterPreferences
LOGGERback to summary
private static final Logger LOGGER
NAMEback to summary
public static final String NAME
textback to summary
private String text

Constructor Detail

TextBasedPreviewLayoutback to summary
public TextBasedPreviewLayout(String text, @NonNull LayoutFormatterPreferences layoutFormatterPreferences, @NonNull JournalAbbreviationRepository abbreviationRepository)
TextBasedPreviewLayoutback to summary
public TextBasedPreviewLayout(Layout layout)

Method Detail

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

Implements org.jabref.logic.preview.PreviewLayout.generatePreview.

Annotations
@Override
getDisplayNameback to summary
public String getDisplayName()

Implements org.jabref.logic.preview.PreviewLayout.getDisplayName.

Annotations
@Override
getNameback to summary
public String getName()

Implements org.jabref.logic.preview.PreviewLayout.getName.

Annotations
@Override
getShortTitleback to summary
public String getShortTitle()

Implements org.jabref.logic.preview.PreviewLayout.getShortTitle.

getTextback to summary
public String getText()

Implements org.jabref.logic.preview.PreviewLayout.getText.

Annotations
@Override
ofback to summary
public static TextBasedPreviewLayout of(@NonNull String style, @NonNull LayoutFormatterPreferences layoutFormatterPreferences, @NonNull JournalAbbreviationRepository abbreviationRepository)
setTextback to summary
public void setText(String text)