com.github.jknack.handlebars.internal.js

Class RhinoHandlebars

java.lang.Object

com.github.jknack.handlebars.js.HandlebarsJs

com.github.jknack.handlebars.internal.js.RhinoHandlebars

public class RhinoHandlebars
extends HandlebarsJs

An implementation of HandlebarsJs on top of Rhino.

Since:

1.1.0

Author:

edgar.espina.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RhinoHandlebars.JsHelper The JavaScript helper contract.
static class	RhinoHandlebars.OptionsJs The Handlebars.js options.

Field Summary

Fields inherited from class com.github.jknack.handlebars.js.HandlebarsJs

registry

Constructor Summary

Constructors

Constructor and Description
RhinoHandlebars(HelperRegistry helperRegistry) Creates a new RhinoHandlebars.

Method Summary

Methods

Modifier and Type	Method and Description
void	registerHelper(String name, RhinoHandlebars.JsHelper helper) Register a helper in the helper registry.
void	registerHelpers(String filename, String source) Register helpers from a JavaScript source.

Methods inherited from class com.github.jknack.handlebars.js.HandlebarsJs

create

Methods inherited from class java.lang.Object

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

Constructor Detail

RhinoHandlebars

public RhinoHandlebars(HelperRegistry helperRegistry)

Creates a new RhinoHandlebars.

Parameters:

helperRegistry - The handlebars object.

Method Detail

registerHelper

public void registerHelper(String name,
                  RhinoHandlebars.JsHelper helper)

Register a helper in the helper registry.

Parameters:

name - The helper's name. Required.

helper - The helper object. Required.

registerHelpers

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

Description copied from class: HandlebarsJs

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.

Specified by:

registerHelpers in class HandlebarsJs

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.