Trait/Object

xitrum.view

TemplateEngine

Related Docs: object TemplateEngine | package view

Permalink

trait TemplateEngine extends AnyRef

Template engines should extend this trait and implement its methods. On startup, an instance of the configured template engine is created and used for every rendering request. Thus it should be thread-safe.

Linear Supertypes
AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TemplateEngine
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def renderFragment(directory: String, fragment: String, currentAction: Action, options: Map[String, Any]): String

    Permalink

    Renders the fragment template at the directory.

    Renders the fragment template at the directory.

    directory

    contains the fragment

    options

    specific to the configured template engine

  2. abstract def renderView(path: String, currentAction: Action, options: Map[String, Any]): String

    Permalink

    Renders the template at the location identified by the path (and may be options, depending on template engines).

    Renders the template at the location identified by the path (and may be options, depending on template engines).

    path

    the template

    options

    specific to the configured template engine

  3. abstract def start(): Unit

    Permalink

    Called once when Xitrum server starts.

    Called once when Xitrum server starts. If necessary the template engine should allocate its resources here.

  4. abstract def stop(): Unit

    Permalink

    Called once when Xitrum server stops.

    Called once when Xitrum server stops. If necessary the template engine should release its resources here.

Concrete Value Members

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped