com.github.jknack.handlebars.js

Class HandlebarsJs

java.lang.Object

com.github.jknack.handlebars.js.HandlebarsJs

Direct Known Subclasses:

RhinoHandlebars

public abstract class HandlebarsJs
extends Object

The main motivation of HandlebarsJs is the ability of reuse JavaScript helpers in the server and the client.

Since:

1.1.0

Author:

edgar.espina

Field Summary

Fields

Modifier and Type	Field and Description
protected HelperRegistry	registry The handlebars instance.

Constructor Summary

Constructors

Constructor and Description
HandlebarsJs(HelperRegistry helperRegistry) Creates a new HelperRegistry object.

Method Summary

Methods

Modifier and Type	Method and Description
static HandlebarsJs	create(HelperRegistry helperRegistry) Creates a HandlebarsJs object.
static HandlebarsJs	createRhino(HelperRegistry helperRegistry, int optimizationLevel) Creates a HandlebarsJs object.
abstract void	registerHelpers(String filename, String source) Register helpers from a JavaScript source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

registry

protected final HelperRegistry registry

The handlebars instance. Required.

Constructor Detail

HandlebarsJs

public HandlebarsJs(HelperRegistry helperRegistry)

Creates a new HelperRegistry object.

Parameters:

helperRegistry - The HelperRegistry instance. Required.

Method Detail

registerHelpers

public abstract void registerHelpers(String filename,
                   String source)
                              throws Exception

Register helpers from a JavaScript source.

A JavaScript source file looks like:

  Handlebars.registerHelper('hey', function (context) {
    return 'Hi ' + context.name;
  });
  ...
  Handlebars.registerHelper('hey', function (context, options) {
    return 'Hi ' + context.name + options.hash['x'];
  });
  ...
  Handlebars.registerHelper('hey', function (context, p1, p2, options) {
    return 'Hi ' + context.name + p1 + p2 + options.hash['x'];
  });
  ...
 

To keep your helpers reusable between server and client avoid DOM manipulation.

Parameters:

filename - The file name (just for debugging purpose). Required.

source - The JavaScript source. Required.

Throws:

Exception - If the JavaScript helpers can't be registered.

create

public static HandlebarsJs create(HelperRegistry helperRegistry)

Creates a HandlebarsJs object.

Parameters:

helperRegistry - The helperRegistry object. Required.

Returns:

A new HandlebarsJs object.

createRhino

public static HandlebarsJs createRhino(HelperRegistry helperRegistry,
                       int optimizationLevel)

Creates a HandlebarsJs object.

Parameters:

helperRegistry - The helperRegistry object. Required.

optimizationLevel - The optimization level of rhino.

Returns:

A new HandlebarsJs object.