laika.render

PDFConfig

case class PDFConfig(insertTitles: Boolean = true, bookmarkDepth: Int = scala.Int.MaxValue, tocDepth: Int = scala.Int.MaxValue, tocTitle: Option[String] = scala.None) extends Product with Serializable

Configuration options for the generated PDF output.

insertTitles

indicates whether a title will be inserted for each tree, subtree, and document, relying on titles specified in the configuration file for the tree or document, but only if there is no Title element in the document already

bookmarkDepth

the number of levels bookmarks should be generated for, use 0 to switch off bookmark generation

tocDepth

the number of levels to generate a table of contents for, use 0 to switch off toc generation

tocTitle

the title for the table of contents

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. PDFConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PDFConfig(insertTitles: Boolean = true, bookmarkDepth: Int = scala.Int.MaxValue, tocDepth: Int = scala.Int.MaxValue, tocTitle: Option[String] = scala.None)

    insertTitles

    indicates whether a title will be inserted for each tree, subtree, and document, relying on titles specified in the configuration file for the tree or document, but only if there is no Title element in the document already

    bookmarkDepth

    the number of levels bookmarks should be generated for, use 0 to switch off bookmark generation

    tocDepth

    the number of levels to generate a table of contents for, use 0 to switch off toc generation

    tocTitle

    the title for the table of contents

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. val bookmarkDepth: Int

    the number of levels bookmarks should be generated for, use 0 to switch off bookmark generation

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  12. val insertTitles: Boolean

    indicates whether a title will be inserted for each tree, subtree, and document, relying on titles specified in the configuration file for the tree or document, but only if there is no Title element in the document already

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  18. val tocDepth: Int

    the number of levels to generate a table of contents for, use 0 to switch off toc generation

  19. val tocTitle: Option[String]

    the title for the table of contents

  20. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped