FOforPDF

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
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
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
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
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
def hashCode(): Int

Definition Classes
AnyRef → Any
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
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
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def prepareTree(tree: DocumentTree, config: Config): 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
def renderFO(tree: DocumentTree, render: (DocumentTree, OutputTree) ⇒ Unit, defaultTemplateRoot: TemplateRoot): 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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: class FOforPDF | package render

object FOforPDF extends FOforPDF

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addTreeTitles(linksOnly: Boolean)(tree: DocumentTree): DocumentTree

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def generateBookmarks(root: DocumentTree, depth: Int): Map[String, Element]

final def getClass(): Class[_]

def hasContent(nav: Navigatable): Boolean

def hasDocuments(tree: DocumentTree): Boolean

def hashCode(): Int

def insertDocTitles(linksOnly: Boolean)(tree: DocumentTree): DocumentTree

def insertToc(tree: DocumentTree, depth: Int, title: Option[String]): DocumentTree

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def prepareTree(tree: DocumentTree, config: Config): DocumentTree

def renderFO(tree: DocumentTree, render: (DocumentTree, OutputTree) ⇒ Unit, defaultTemplateRoot: TemplateRoot): String

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from FOforPDF

Inherited from AnyRef

Inherited from Any

Ungrouped