vertx-lang-scala-docs_2.12 3.5.3.CR1 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package web
  Definition Classes
    ext
-  package templ
  Definition Classes
    web
- FreeMarkerTemplateEngine
- HandlebarsTemplateEngine
- JadeTemplateEngine
- MVELTemplateEngine
- PebbleTemplateEngine
- TemplateEngine
- ThymeleafTemplateEngine

c

io.vertx.scala.ext.web.templ

# TemplateEngine 

###
Companion object TemplateEngine

#### class TemplateEngine extends AnyRef

A template engine uses a specific template and the data in a routing context to render a resource into a buffer.

Concrete implementations exist for several well-known template engines.

Linear Supertypes
AnyRef, Any
Known Subclasses
FreeMarkerTemplateEngine, HandlebarsTemplateEngine, JadeTemplateEngine, MVELTemplateEngine, PebbleTemplateEngine, ThymeleafTemplateEngine
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. TemplateEngine
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new TemplateEngine(_asJava: AnyRef)

### 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 asJava: AnyRef
6.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
7.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
8.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
9.  def finalize(): Unit
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( classOf[java.lang.Throwable] )
10.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
11.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
12.  def isCachingEnabled(): Boolean

    Returns true if the template engine caches template files.

    Returns true if the template engine caches template files. If false, then template files are freshly loaded each time they are used.

    returns

      True if template files are cached; otherwise, false.

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()
16.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
17.  def render(context: RoutingContext, templateDirectory: String, templateFileName: String, handler: Handler[AsyncResult[Buffer]]): Unit

    Render the template

    Render the template

    NOTE if you call method directly (i.e. not using io.vertx.scala.ext.web.handler.TemplateHandler) make sure that templateFileName is sanitized via io.vertx.scala.ext.web.impl.Utils#normalizePath

    context

      the routing context

    templateDirectory

      the template directory to use

    templateFileName

      the relative template file name to use

    handler

      the handler that will be called with a result containing the buffer or a failure.

18.  def render(context: RoutingContext, templateFileName: String, handler: Handler[AsyncResult[Buffer]]): Unit

    Render the template

    Render the template

    context

      the routing context

    templateFileName

      the template file name to use

    handler

      the handler that will be called with a result containing the buffer or a failure.

19.  def renderFuture(context: RoutingContext, templateDirectory: String, templateFileName: String): Future[Buffer]

    Like render but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

20.  def renderFuture(context: RoutingContext, templateFileName: String): Future[Buffer]

    Like render but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

21.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
22.  def toString(): String
    Definition Classes
      AnyRef → Any
23.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
24.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
25.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped