Packages

object FOforPDF extends FOforPDF

The default FOforPDF instance using a PDFConfig with all optional features like document titles, bookmarks and table of content enabled.

Linear Supertypes
FOforPDF, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FOforPDF
  2. FOforPDF
  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. def addTreeTitles(linksOnly: Boolean)(tree: DocumentTree): DocumentTree

    Adds title elements for each tree and subtree in the specified root tree.

    Adds title elements for each tree and subtree in the specified root tree. Tree titles can be specified in the configuration file for each tree.

    Definition Classes
    FOforPDF
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def generateBookmarks(root: DocumentTree, depth: Int): Map[String, Element]

    Generates bookmarks for the structure of the DocumentTree.

    Generates bookmarks for the structure of the DocumentTree. Individual bookmarks can stem from tree or subtree titles, document titles or document sections, depending on which recursion depth is configured. The configuration key for setting the recursion depth is pdf.bookmarks.depth.

    root

    the document tree to generate bookmarks for

    returns

    a fragment map containing the generated bookmarks

    Definition Classes
    FOforPDF
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hasContent(nav: Navigatable): Boolean

    Indicates whether the specified navigatable contains at least one document.

    Indicates whether the specified navigatable contains at least one document.

    Attributes
    protected
    Definition Classes
    FOforPDF
  13. def hasDocuments(tree: DocumentTree): Boolean

    Indicates whether the specified tree contains at least one document.

    Indicates whether the specified tree contains at least one document.

    Attributes
    protected
    Definition Classes
    FOforPDF
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def insertDocTitles(linksOnly: Boolean)(tree: DocumentTree): DocumentTree

    Adds title elements for each document in the specified tree, including documents in subtrees.

    Adds title elements for each document in the specified tree, including documents in subtrees. Document titles will be obtained either from a Title element in the document's content or from its configuration header.

    Definition Classes
    FOforPDF
  16. def insertToc(tree: DocumentTree, depth: Int, title: Option[String]): DocumentTree

    Inserts a table of content into the specified document tree.

    Inserts a table of content into the specified document tree. The recursion depth can be set with the configuration key pdf.toc.depth.

    Definition Classes
    FOforPDF
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def prepareTree(tree: DocumentTree, config: PDFConfig): DocumentTree

    Prepares the document tree before rendering the interim XSL-FO output.

    Prepares the document tree before rendering the interim XSL-FO output. Preparation may include insertion of tree or document titles and a table of content, depending on configuration.

    Definition Classes
    FOforPDF
  22. 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, depending on configuration settings.

    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

    Definition Classes
    FOforPDF
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from FOforPDF

Inherited from AnyRef

Inherited from Any

Ungrouped