io.vertx.ext.web.templ.handlebars

## Interface HandlebarsTemplateEngine

- All Superinterfaces:
    TemplateEngine

      public interface HandlebarsTemplateEngine
      extends TemplateEngine

  A template engine that uses the Handlebars library. The `TemplateEngine.unwrap()` shall return an object of class `Handlebars`
  Author:
    Tim Fox

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `DEFAULT_TEMPLATE_EXTENSION` Default template extension

  - ### Method Summary

    All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `static HandlebarsTemplateEngine` | `create(Vertx vertx)` Create a template engine using defaults
    `static HandlebarsTemplateEngine` | `create(Vertx vertx, String extension)` Create a template engine using defaults
    `com.github.jknack.handlebars.Handlebars` | `getHandlebars()` Deprecated. see `TemplateEngine.unwrap()` Get a reference to the internal Handlebars object so it can be configured.
    `com.github.jknack.handlebars.ValueResolver[]` | `getResolvers()` Deprecated. see `TemplateEngine.unwrap()` Return the array of configured handlebars context value resolvers.
    `HandlebarsTemplateEngine` | `setResolvers(com.github.jknack.handlebars.ValueResolver... resolvers)` Deprecated. see `TemplateEngine.unwrap()` Set the array of handlebars context value resolvers.

    - ### Methods inherited from interface io.vertx.ext.web.common.template.TemplateEngine

      `clearCache, render, render, render, render, unwrap`

- - ### Field Detail

    - #### DEFAULT_TEMPLATE_EXTENSION

          static final String DEFAULT_TEMPLATE_EXTENSION

      Default template extension
      See Also:
        Constant Field Values

  - ### Method Detail

    - #### create

          static HandlebarsTemplateEngine create(Vertx vertx)

      Create a template engine using defaults
      Returns:
        the engine

    - #### create

          static HandlebarsTemplateEngine create(Vertx vertx,
                                                 String extension)

      Create a template engine using defaults
      Returns:
        the engine

    - #### getHandlebars

          @Deprecated
          com.github.jknack.handlebars.Handlebars getHandlebars()

      Deprecated. see `TemplateEngine.unwrap()` Get a reference to the internal Handlebars object so it can be configured.
      Returns:
        a reference to the internal Handlebars instance.

    - #### getResolvers

          @Deprecated
          com.github.jknack.handlebars.ValueResolver[] getResolvers()

      Deprecated. see `TemplateEngine.unwrap()` Return the array of configured handlebars context value resolvers.
      Returns:
        array of configured resolvers

    - #### setResolvers

          @Deprecated
          HandlebarsTemplateEngine setResolvers(com.github.jknack.handlebars.ValueResolver... resolvers)

      Deprecated. see `TemplateEngine.unwrap()` Set the array of handlebars context value resolvers.
      Parameters:
        `resolvers` - the value resolvers to be used
      Returns:
        a reference to the internal Handlebars instance.

Copyright © 2024 Eclipse. All rights reserved.