class TemplateEngine extends common.template.TemplateEngine
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.
- Alphabetic
- By Inheritance
- TemplateEngine
- TemplateEngine
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new TemplateEngine(_asJava: AnyRef)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
asJava: AnyRef
- Definition Classes
- TemplateEngine
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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. * @return True if template files are cached; otherwise, false.
- Definition Classes
- TemplateEngine → TemplateEngine
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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 * @param 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.
-
def
render(context: RoutingContext, templateFileName: String, handler: Handler[AsyncResult[Buffer]]): Unit
Render the template * @param context the routing context
Render the template * @param 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.
-
def
render(context: JsonObject, templateFileName: String, handler: Handler[AsyncResult[Buffer]]): Unit
Render the template.
Render the template. Template engines that support partials/fragments should extract the template base path from the template filename up to the last file separator.
Some engines support localization, for these engines, there is a predefined key "lang" to specify the language to be used in the localization, the format should follow the standard locale formats e.g.: "en-gb", "pt-br", "en". * @param 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
-
def
renderFuture(context: RoutingContext, templateDirectory: String, templateFileName: String): Future[Buffer]
Like render but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
-
def
renderFuture(context: RoutingContext, templateFileName: String): Future[Buffer]
Like render but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
-
def
renderFuture(context: JsonObject, 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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )