/*
 * Copyright 2016 Red Hat, Inc.
 *
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  and Apache License v2.0 which accompanies this distribution.
 *
 *  The Eclipse Public License is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *
 *  The Apache License v2.0 is available at
 *  http://www.opensource.org/licenses/apache2.0.php
 *
 *  You may elect to redistribute this code under either of these licenses.
 */

package io.vertx.ext.web.templ;

import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;
import io.vertx.core.Vertx;
import io.vertx.core.buffer.Buffer;
import io.vertx.core.json.JsonObject;
import io.vertx.ext.web.RoutingContext;

A template engine that uses the FreeMarker library.
Author:Paulo Lopes
Deprecated:please use FreeMarkerTemplateEngine instead.
/** * A template engine that uses the FreeMarker library. * * @author <a href="mailto:plopes@redhat.com">Paulo Lopes</a> * @deprecated please use {@link io.vertx.ext.web.templ.freemarker.FreeMarkerTemplateEngine} instead. */
@Deprecated public interface FreeMarkerTemplateEngine extends io.vertx.ext.web.templ.freemarker.FreeMarkerTemplateEngine {
Create a template engine using defaults
Returns: the engine
/** * Create a template engine using defaults * * @return the engine */
static io.vertx.ext.web.templ.freemarker.FreeMarkerTemplateEngine create(Vertx vertx) { return io.vertx.ext.web.templ.freemarker.FreeMarkerTemplateEngine.create(vertx); }
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".
Params:
  • 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.
/** * 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 * @param templateFileName the template file name to use * @param handler the handler that will be called with a result containing the buffer or a failure. */
@Deprecated default void render(RoutingContext context, String templateFileName, Handler<AsyncResult<Buffer>> handler) { // restore the deprecated "context" top level key context.put("context", context.data()); render(context.data(), templateFileName, handler); } }