org.trimou.handlebars

Class ChooseHelper

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.handlebars.AbstractHelper

org.trimou.handlebars.BasicHelper

org.trimou.handlebars.BasicSectionHelper

org.trimou.handlebars.ChooseHelper

All Implemented Interfaces:

ConfigurationAware, Helper

public class ChooseHelper
extends BasicSectionHelper

This helper works similarly as the JSP c:choose tag. It renders the content of the first when section whose first param is not falsy. If no when section is rendered, otherwise section is rendered, if present.

At the moment it's not possible to validate the helper content properly. However, it should only contain when and otherwise sections. Other types of segments are always rendered.

Since we push the flow object on the context stack, it's possible to refer the last context object with Nested.up() method. See also examples.

The following template:

 {{#choose}}
   {{#when this.up}}
      Hello active!
   {{/when}}
   {{#when foo}}
      Hello foo!
   {{/when}}
   {{#otherwise}}
      No match.
   {{/otherwise}}
 {{/switch}}
 

will render "Hello active!" if last context object (i.e. "this" before we enter the choose helper) is not falsy. "Hello foo" if "this.up" is falsy and "foo" is not falsy. And "No match." if both "this.up" and "foo" are falsy.

Author:

Martin Kouba

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChooseHelper.OtherwiseHelper
static class	ChooseHelper.WhenHelper The first param is the test condition.

Field Summary

Fields inherited from class org.trimou.handlebars.BasicSectionHelper

SECTION_TYPES

Fields inherited from class org.trimou.handlebars.BasicHelper

HELPER_TAG_TYPES

Constructor Summary

Constructors

Constructor and Description
ChooseHelper()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(Options options) Execute the helper.
protected int	numberOfRequiredParameters()

Methods inherited from class org.trimou.handlebars.BasicSectionHelper

allowedTagTypes

Methods inherited from class org.trimou.handlebars.BasicHelper

numberOfRequiredHashEntries, validate

Methods inherited from class org.trimou.handlebars.AbstractHelper

append, getHashValue, init, isSection, isUnescapeVariable, isVariable

Methods inherited from class org.trimou.engine.config.AbstractConfigurationAware

getConfigurationKeys, checkNotInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.trimou.engine.config.ConfigurationAware

getConfigurationKeys

Constructor Detail

ChooseHelper

public ChooseHelper()

Method Detail

numberOfRequiredParameters

protected int numberOfRequiredParameters()

Overrides:

numberOfRequiredParameters in class BasicHelper

execute

public void execute(Options options)

Description copied from interface: Helper

Execute the helper.