Packages

class PDF extends RenderResultProcessor[FOWriter]

A post processor for PDF output, based on an interim XSL-FO renderer. May be directly passed to the Render or Transform APIs:

val document: Document = ...
Render as PDF from document toFile "hello.pdf"

Transform from Markdown to PDF fromDirectory "book-src" toFile "book.pdf"

In the second example above the input from an entire directory gets merged into a single output directory.

Linear Supertypes
RenderResultProcessor[FOWriter], AnyRef, Any
Known Subclasses
PDF
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PDF
  2. RenderResultProcessor
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. val factory: XSLFO
    Definition Classes
    PDF → RenderResultProcessor
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def process(tree: DocumentTree, render: (DocumentTree, OutputConfig) ⇒ Unit, output: BinaryOutput): Unit

    Processes the tree by first using the specified render function to produce the interim XSL-FO result, transform the result to PDF and write it to the specified final output.

    Processes the tree by first using the specified render function to produce the interim XSL-FO result, transform the result to PDF and write it to the specified final output.

    tree

    the tree to render to the interim result

    render

    the render function for producing the interim XSL-FO result

    output

    the output to write the final result to

    Definition Classes
    PDF → RenderResultProcessor
  17. def renderFO(tree: DocumentTree, render: (DocumentTree, OutputConfig) ⇒ Unit): String

    Renders the XSL-FO that serves as a basis for producing the final PDF output.

    Renders the XSL-FO that serves as a basis for producing the final PDF output. The result should include the output from rendering the documents in the specified tree as well as any additional insertions like bookmarks or table of content. For this the specified DocumentTree instance may get modified before passing it to the given render function.

    The default implementation simply delegates to an instance of FOforPDF which uses a PDFConfig object to drive configuration. In rare cases where the flexibility provided by PDFConfig is not sufficient, this method may get overridden.

    tree

    the document tree serving as input for the renderer

    render

    the actual render function for producing the XSL-FO output

    returns

    the rendered XSL-FO as a String

    Attributes
    protected
  18. def renderPDF(foInput: Input, output: BinaryOutput, sourcePaths: Seq[String] = Nil): Unit

    Render the given XSL-FO input as a PDF to the specified binary output.

    Render the given XSL-FO input as a PDF to the specified binary output. The optional sourcePaths argument may be used to allow resolving relative paths for loading external files like images.

    foInput

    the input in XSL-FO format

    output

    the output to write the final result to

    sourcePaths

    the paths that may contain files like images which will be used to resolve relative paths

  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  24. def withConfig(config: PDFConfig): PDF

    Allows to specify configuration options like insertion of bookmarks or table of content.

  25. def withFopFactory(fopFactory: FopFactory): PDF

    Allows to specify a custom FopFactory in case additional configuration is required for custom fonts, stemmers or other FOP features.

    Allows to specify a custom FopFactory in case additional configuration is required for custom fonts, stemmers or other FOP features.

    A FopFactory is a fairly heavy-weight object, so make sure that you reuse either the FopFactory instance itself or the resulting PDF renderer. In case you do not specify a custom factory, Laika ensures that the default factory is reused between renderers.

  26. def withMessageLevel(level: MessageLevel): PDF

    Specifies the minimum required level for a system message to get included into the output by this renderer.

Inherited from RenderResultProcessor[FOWriter]

Inherited from AnyRef

Inherited from Any

Ungrouped