Packages

case class BookConfig(metadata: DocumentMetadata = DocumentMetadata(), navigationDepth: Option[Int] = None, fonts: Seq[FontDefinition] = Nil, coverImage: Option[Path] = None) extends Product with Serializable

Captures common configuration element of e-books, used by both EPUB and PDF renderers.

metadata

metadata to be embedded in the document in a way that respective reader software can surface

navigationDepth

the number of levels to provide navigation structure for

fonts

the fonts that should be embedded in the e-book output

coverImage

the path to the cover image within the virtual document tree

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BookConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BookConfig(metadata: DocumentMetadata = DocumentMetadata(), navigationDepth: Option[Int] = None, fonts: Seq[FontDefinition] = Nil, coverImage: Option[Path] = None)

    metadata

    metadata to be embedded in the document in a way that respective reader software can surface

    navigationDepth

    the number of levels to provide navigation structure for

    fonts

    the fonts that should be embedded in the e-book output

    coverImage

    the path to the cover image within the virtual document tree

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. val coverImage: Option[Path]
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. val fonts: Seq[FontDefinition]
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val metadata: DocumentMetadata
  13. val navigationDepth: Option[Int]
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped