laika.tree.Documents

DocumentContext

class DocumentContext extends AnyRef

Represents a single document,its parent and root directories, its asssociated template and other context information that can not be obtained from the Document instance itself.

Self Type
DocumentContext
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DocumentContext
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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 autonumbering: AutonumberContext

    the context for autonumbering of document and sections

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. lazy val config: Config

    The configuration for this document merged with the configurations for its parent trees.

  10. val document: Document

    the document this context refers to

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

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

    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  15. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  16. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  20. val parent: DocumentTree

    the parent document tree of the referred document

  21. lazy val parents: Seq[DocumentTree]

    Attributes
    protected
  22. def resolveReference(path: String): Option[Any]

    Resolves the context reference with the specified path relative to this document.

    Resolves the context reference with the specified path relative to this document. A reference config.value for example will first look up the value in the configuration of this document and then, if not found, recursively look it up in parent trees until the root tree is reached. If the value is not found None will be returned.

  23. lazy val resolver: ReferenceResolver

    Attributes
    protected
  24. val root: DocumentTree

    the root document tree of the referred document

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

    Definition Classes
    AnyRef
  26. lazy val template: Option[TemplateDocument]

    The (optional) template to use when rendering this document.

  27. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def withDocument(newDoc: Document): DocumentContext

    Creates a copy of this context for the specified document while keeping all the other information.

  32. def withReferenceContext(target: Any): DocumentContext

    Creates a copy of this context with a new root object for resolving references.

    Creates a copy of this context with a new root object for resolving references. This is useful for custom template directives which need to provide a new scope for a nested part inside the directive tags.

Inherited from AnyRef

Inherited from Any

Ungrouped