Top Description Fields Constructors Methods
de.undercouch.citeproc.csl.internal.format

public Class FoFormat

extends BaseFormat
Class Inheritance
Imports
de.undercouch.citeproc.csl.internal.RenderContext, .SBibliography, .TokenBuffer, de.undercouch.citeproc.csl.internal.token.DisplayGroupToken, .Token, de.undercouch.citeproc.output.Bibliography, .SecondFieldAlign, org.apache.commons.text.StringEscapeUtils, java.util.List
The XSL-FO output format
Author
Michel Kraemer

Field Summary

Modifier and TypeField and Description
private final String
columnWidth

Inherited from de.undercouch.citeproc.csl.internal.format.BaseFormat:
convertLinks

Constructor Summary

AccessConstructor and Description
public
FoFormat()

Default constructor

public
FoFormat(String
the width of the first column if SecondFieldAlign is enabled
columnWidth)

Constructs a new output format

Method Summary

Modifier and TypeMethod and Description
protected String
closeDisplayGroup(DisplayGroupToken.Type type)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.closeDisplayGroup.

Generate text that closes a display group

protected String
closeFontStyle(int fontStyle)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.closeFontStyle.

Generate text that disables the given font style in the output format

protected String
closeFontVariant(int fontVariant)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.closeFontVariant.

Generate text that disables the given font variant in the output format

protected String
closeFontWeight(int fontWeight)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.closeFontWeight.

Generate text that disables the given font weight in the output format

protected String
closeTextDecoration(int textDecoration)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.closeTextDecoration.

Generate text that disables the given text decoration in the output format

protected String
closeVerticalAlign(int verticalAlign)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.closeVerticalAlign.

Generate text that disables the given vertical alignment in the output format

protected String
doFormatBibliographyEntry(TokenBuffer buffer, RenderContext ctx, int index)

Implements abstract de.undercouch.citeproc.csl.internal.format.BaseFormat.doFormatBibliographyEntry.

Convert a bibliography entry from a post-processed buffer to a string

protected String
doFormatCitation(TokenBuffer buffer, RenderContext ctx)

Implements abstract de.undercouch.citeproc.csl.internal.format.BaseFormat.doFormatCitation.

Convert a citation from a post-processed buffer to a string

protected String
escape(String str)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.escape.

Escape any formatting instructions specific to the output format

public String
getName()

Implements de.undercouch.citeproc.csl.internal.format.Format.getName.

Get the format's name

public Bibliography
makeBibliography(String[] entries, SBibliography bibliographyElement)

Implements de.undercouch.citeproc.csl.internal.format.Format.makeBibliography.

Create a Bibliography object with the given entries and default parameters specified by this format

protected String
openDisplayGroup(DisplayGroupToken.Type type)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openDisplayGroup.

Generate text that opens a display group

protected String
openFontStyle(int fontStyle)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openFontStyle.

Generate text that enables the given font style in the output format

protected String
openFontVariant(int fontVariant)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openFontVariant.

Generate text that enables the given font variant in the output format

protected String
openFontWeight(int fontWeight)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openFontWeight.

Generate text that enables the given font weight in the output format

protected String
openTextDecoration(int textDecoration)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openTextDecoration.

Generate text that enables the given text decoration in the output format

protected String
openVerticalAlign(int verticalAlign)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openVerticalAlign.

Generate text that enables the given vertical alignment in the output format

Inherited from de.undercouch.citeproc.csl.internal.format.BaseFormat:
addDOIPrefixformatformatBibliographyEntryformatCitationformatDOIformatURLpostProcesssetConvertLinks

Field Detail

columnWidthback to summary
private final String columnWidth

Constructor Detail

FoFormatback to summary
public FoFormat()

Default constructor

FoFormatback to summary
public FoFormat(String columnWidth)

Constructs a new output format

Parameters
columnWidth:String

the width of the first column if SecondFieldAlign is enabled

Method Detail

closeDisplayGroupback to summary
protected String closeDisplayGroup(DisplayGroupToken.Type type)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.closeDisplayGroup.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.closeDisplayGroup.

Generate text that closes a display group

Annotations
@Override
closeFontStyleback to summary
protected String closeFontStyle(int fontStyle)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.closeFontStyle.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.closeFontStyle.

Generate text that disables the given font style in the output format

Annotations
@Override
closeFontVariantback to summary
protected String closeFontVariant(int fontVariant)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.closeFontVariant.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.closeFontVariant.

Generate text that disables the given font variant in the output format

Annotations
@Override
closeFontWeightback to summary
protected String closeFontWeight(int fontWeight)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.closeFontWeight.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.closeFontWeight.

Generate text that disables the given font weight in the output format

Annotations
@Override
closeTextDecorationback to summary
protected String closeTextDecoration(int textDecoration)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.closeTextDecoration.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.closeTextDecoration.

Generate text that disables the given text decoration in the output format

Annotations
@Override
closeVerticalAlignback to summary
protected String closeVerticalAlign(int verticalAlign)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.closeVerticalAlign.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.closeVerticalAlign.

Generate text that disables the given vertical alignment in the output format

Annotations
@Override
doFormatBibliographyEntryback to summary
protected String doFormatBibliographyEntry(TokenBuffer buffer, RenderContext ctx, int index)

Implements abstract de.undercouch.citeproc.csl.internal.format.BaseFormat.doFormatBibliographyEntry.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.doFormatBibliographyEntry.

Convert a bibliography entry from a post-processed buffer to a string

Annotations
@Override
doFormatCitationback to summary
protected String doFormatCitation(TokenBuffer buffer, RenderContext ctx)

Implements abstract de.undercouch.citeproc.csl.internal.format.BaseFormat.doFormatCitation.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.doFormatCitation.

Convert a citation from a post-processed buffer to a string

Annotations
@Override
doFormatLinkback to summary
protected String doFormatLink(String text, String uri)

Implements abstract de.undercouch.citeproc.csl.internal.format.BaseFormat.doFormatLink.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.doFormatLink.

Convert the given string to a link

Annotations
@Override
escapeback to summary
protected String escape(String str)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.escape.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.escape.

Escape any formatting instructions specific to the output format

Annotations
@Override
getNameback to summary
public String getName()

Implements de.undercouch.citeproc.csl.internal.format.Format.getName.

Doc from de.undercouch.citeproc.csl.internal.format.Format.getName.

Get the format's name

Annotations
@Override
makeBibliographyback to summary
public Bibliography makeBibliography(String[] entries, SBibliography bibliographyElement)

Implements de.undercouch.citeproc.csl.internal.format.Format.makeBibliography.

Doc from de.undercouch.citeproc.csl.internal.format.Format.makeBibliography.

Create a Bibliography object with the given entries and default parameters specified by this format

Annotations
@Override
openDisplayGroupback to summary
protected String openDisplayGroup(DisplayGroupToken.Type type)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openDisplayGroup.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.openDisplayGroup.

Generate text that opens a display group

Annotations
@Override
openFontStyleback to summary
protected String openFontStyle(int fontStyle)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openFontStyle.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.openFontStyle.

Generate text that enables the given font style in the output format

Annotations
@Override
openFontVariantback to summary
protected String openFontVariant(int fontVariant)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openFontVariant.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.openFontVariant.

Generate text that enables the given font variant in the output format

Annotations
@Override
openFontWeightback to summary
protected String openFontWeight(int fontWeight)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openFontWeight.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.openFontWeight.

Generate text that enables the given font weight in the output format

Annotations
@Override
openTextDecorationback to summary
protected String openTextDecoration(int textDecoration)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openTextDecoration.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.openTextDecoration.

Generate text that enables the given text decoration in the output format

Annotations
@Override
openVerticalAlignback to summary
protected String openVerticalAlign(int verticalAlign)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openVerticalAlign.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.openVerticalAlign.

Generate text that enables the given vertical alignment in the output format

Annotations
@Override