case class Font extends Product with Serializable

Represents a font resource, either based on a local classpath or file system resource, or a web font URL, or both.

E-book formats like EPUB or PDF require a local font file to be available for embedding. A web font URL can only be used for website generation.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Font
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. def definedAs(family: String, weight: FontWeight, style: FontStyle): FontDefinition

    Creates the final FontDefinition instance that can be used in Laika's and Helium's configuration by mapping the font resource to a family name, font weight and style.

  7. def embedFile(file: FilePath): Font

    Specifies a font file that can be used for embedding in EPUB or PDF.

    Specifies a font file that can be used for embedding in EPUB or PDF. This is one of the few places in Laika where a real file-system path needs to be provided, not a path from the library's virtual path.

  8. def embedFile(name: String): Font

    Specifies a font file that can be used for embedding in EPUB or PDF.

    Specifies a font file that can be used for embedding in EPUB or PDF. This is one of the few places in Laika where a real file-system path needs to be provided, not a path from the library's virtual path.

  9. def embedResource(name: String): Font

    Specifies a font file as a classpath resource that can be used for embedding in EPUB or PDF.

    Specifies a font file as a classpath resource that can be used for embedding in EPUB or PDF. For theme authors classpath resources are the recommended way of providing default fonts.

  10. val embedResource: Option[EmbeddedFont]
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  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
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. def webCSS(url: String): Font

    Specifies a URL for a web font which can be auto-linked in a theme template.

  22. val webCSS: Option[String]

Deprecated Value Members

  1. def embedFile(file: File): Font
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) use embedFile(String) or embedFile(FilePath)

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped