Packages

class FreeMarkerTemplateEngine extends TemplateEngine

A template engine that uses the FreeMarker library.

Linear Supertypes
TemplateEngine, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FreeMarkerTemplateEngine
  2. TemplateEngine
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FreeMarkerTemplateEngine(_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
    Definition Classes
    TemplateEngine
  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.

    Definition Classes
    TemplateEngine
  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.

    Definition Classes
    TemplateEngine
  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.

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

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

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

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

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

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

    Definition Classes
    TemplateEngine
  21. def setExtension(extension: String): FreeMarkerTemplateEngine

    Set the extension for the engine

    Set the extension for the engine

    extension

    the extension

    returns

    a reference to this for fluency

  22. def setMaxCacheSize(maxCacheSize: Int): FreeMarkerTemplateEngine

    Set the max cache size for the engine

    Set the max cache size for the engine

    maxCacheSize

    the maxCacheSize

    returns

    a reference to this for fluency

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

Inherited from TemplateEngine

Inherited from AnyRef

Inherited from Any

Ungrouped