laika-core
API
Generated with
laika-core/laika/laika.render/FOFormatter

FOFormatter

laika.render.FOFormatter$
See theFOFormatter companion class
object FOFormatter extends RenderContext[FOFormatter] => FOFormatter

Companion providing tree elements specific to the XSL-FO renderer. These are usually not part of the document AST produced by a parser, but only inserted dynamically during the render process to drive features specific to FO output.

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Classlikes

case class BookmarkTitle(content: String, options: Options) extends Block, TextContainer

A bookmark title.

A bookmark title.

Attributes

Supertypes
trait Container[String]
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ContentWrapper(content: String, options: Options) extends Block

A wrapper around pre-rendered content which can be used to set default attributes that can be inherited by any node in the document.

A wrapper around pre-rendered content which can be used to set default attributes that can be inherited by any node in the document.

Attributes

Supertypes
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class FootnoteBody(content: Seq[Block], options: Options) extends Block, BlockContainer

The body of a footnote containing a sequence of block elements.

The body of a footnote containing a sequence of block elements.

Attributes

Supertypes
trait Container[Seq[Block]]
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Leader(options: Options) extends Span

A leader element.

A leader element.

Attributes

Supertypes
trait Span
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ListItemBody(content: Seq[Block], options: Options) extends Block, BlockContainer

The body of a list item containing a sequence of block elements.

The body of a list item containing a sequence of block elements.

Attributes

Supertypes
trait Container[Seq[Block]]
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ListItemLabel(content: Block, options: Options) extends Block

A label for a list item, represented by a single Block element.

A label for a list item, represented by a single Block element.

Attributes

Supertypes
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class PageNumberCitation(target: InternalTarget, options: Options) extends Span

An internal link to be rendered as a page number.

An internal link to be rendered as a page number.

Value parameters

options

optional render hints

target

the path of the target document containing the local reference

Attributes

Supertypes
trait Span
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Preamble(title: String, options: Options) extends Block

A preamble for a document, only used in PDF output where multiple XSL-FO documents get concatenated before being passed to the PDF renderer.

A preamble for a document, only used in PDF output where multiple XSL-FO documents get concatenated before being passed to the PDF renderer.

Attributes

Supertypes
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def apply(context: RenderContext[FOFormatter]): FOFormatter

Creates a new formatter instance based on the specified render context.

Creates a new formatter instance based on the specified render context.

Attributes

Inherited methods

def andThen[A](g: FOFormatter => A): T1 => A

Attributes

Inherited from:
Function1
def compose[A](g: A => RenderContext[FOFormatter]): A => R

Attributes

Inherited from:
Function1
Generated with