Package io.vertx.ext.web.handler
Interface TemplateHandler
-
- All Superinterfaces:
Handler<RoutingContext>
public interface TemplateHandler extends Handler<RoutingContext>
A handler which renders responses using a template engine and where the template name is selected from the URI path.- Author:
- Tim Fox
-
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_CONTENT_TYPE
The default content type header to be used in the responsestatic String
DEFAULT_INDEX_TEMPLATE
The default index pagestatic String
DEFAULT_TEMPLATE_DIRECTORY
The default directory where templates will be looked for
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static TemplateHandler
create(TemplateEngine engine)
Create a handlerstatic TemplateHandler
create(TemplateEngine engine, String templateDirectory, String contentType)
Create a handlerTemplateHandler
setIndexTemplate(String indexTemplate)
Set the index template
-
-
-
Field Detail
-
DEFAULT_TEMPLATE_DIRECTORY
static final String DEFAULT_TEMPLATE_DIRECTORY
The default directory where templates will be looked for- See Also:
- Constant Field Values
-
DEFAULT_CONTENT_TYPE
static final String DEFAULT_CONTENT_TYPE
The default content type header to be used in the response- See Also:
- Constant Field Values
-
DEFAULT_INDEX_TEMPLATE
static final String DEFAULT_INDEX_TEMPLATE
The default index page- See Also:
- Constant Field Values
-
-
Method Detail
-
setIndexTemplate
TemplateHandler setIndexTemplate(String indexTemplate)
Set the index template- Parameters:
indexTemplate
- the index template- Returns:
- a reference to this, so the API can be used fluently
-
create
static TemplateHandler create(TemplateEngine engine)
Create a handler- Parameters:
engine
- the template engine- Returns:
- the handler
-
create
static TemplateHandler create(TemplateEngine engine, String templateDirectory, String contentType)
Create a handler- Parameters:
engine
- the template enginetemplateDirectory
- the template directory where templates will be looked forcontentType
- the content type header to be used in the response- Returns:
- the handler
-
-