PartialBlockForwardingTemplate (Handlebars 4.2.0 API)

java.lang.Object
- com.github.jknack.handlebars.internal.PartialBlockForwardingTemplate

All Implemented Interfaces:: Template

public class PartialBlockForwardingTemplate
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`column` The column of this template.
`protected String`	`filename` The file's name.
`protected Handlebars`	`handlebars` The handlebars object.
`protected int`	`line` The line of this template.

Fields inherited from interface com.github.jknack.handlebars.Template
EMPTY

Constructor Summary

Constructors
Constructor and Description
`PartialBlockForwardingTemplate(Template parent, Template block, Template parentPartialBlock, Template callee, Handlebars handlebars)` Constructs a PartialBlockForwardingTemplate.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`after(Context context, Writer writer)` Notify that template has been processed.
`String`	`apply(Context context)` Merge the template tree using the given context.
`void`	`apply(Context context, Writer writer)` Merge the template tree using the given context.
`String`	`apply(Object context)` Merge the template tree using the given context.
`void`	`apply(Object context, Writer writer)` Merge the template tree using the given context.
`<T> TypeSafeTemplate<T>`	`as()` Creates a new `TypeSafeTemplate`.
`<T,S extends TypeSafeTemplate<T>> S`	`as(Class<S> rootType)` Creates a new `TypeSafeTemplate`.
`void`	`before(Context context, Writer writer)` Notify that template is going to be processed.
`protected void`	`collect(Collection<String> result, TagType tagType)` Child classes might want to check if they apply to the tagtype and append them self to the result list.
`List<String>`	`collect(TagType... tagType)` Collect all the tag names under the given tagType.
`List<String>`	`collectReferenceParameters()` Collects all the parameters which are also variables.
`protected void`	`collectReferenceParameters(Collection<String> result)`
`boolean`	`decorate()`
`String`	`filename()`
`com.github.jknack.handlebars.internal.BaseTemplate`	`filename(String filename)` Set the file's name.
`protected void`	`merge(Context context, Writer writer)` Merge a child template into the writer.
`int[]`	`position()`
`com.github.jknack.handlebars.internal.BaseTemplate`	`position(int line, int column)` Set the template position.
`String`	`text()` Provide the raw text.
`String`	`toJavaScript()` Convert this template to JavaScript template (a.k.a precompiled template).
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - handlebars
```
protected final Handlebars handlebars
```
    The handlebars object. Required.
  - line
```
protected int line
```
    The line of this template.
  - column
```
protected int column
```
    The column of this template.
  - filename
```
protected String filename
```
    The file's name.
- Constructor Detail
  - PartialBlockForwardingTemplate
```
public PartialBlockForwardingTemplate(Template parent,
                                      Template block,
                                      Template parentPartialBlock,
                                      Template callee,
                                      Handlebars handlebars)
```
    Constructs a PartialBlockForwardingTemplate.
    
    Parameters:
    
    parent - the parent partial
    
    block - the block to be passed as partial-block.
    
    parentPartialBlock - the previous partial-block definition of the template which contains this partial.
    
    callee - the template that renders the parent
    
    handlebars - handlebars
- Method Detail
  - merge
```
protected void merge(Context context,
                     Writer writer)
              throws IOException
```
    Merge a child template into the writer.
    
    Parameters:
    
    context - The scope object.
    
    writer - The writer.
    
    Throws:
    
    IOException - If a resource cannot be loaded.
  - text
```
public String text()
```
    Provide the raw text.
    
    Returns:
    
    The raw text.
  - apply
```
public final String apply(Object context)
                   throws IOException
```
    Merge the template tree using the given context.
    
    Specified by:
    
    apply in interface Template
    
    Parameters:
    
    context - The context object. May be null.
    
    Returns:
    
    The resulting template.
    
    Throws:
    
    IOException - If a resource cannot be loaded.
  - apply
```
public final void apply(Object context,
                        Writer writer)
                 throws IOException
```
    Merge the template tree using the given context.
    
    Specified by:
    
    apply in interface Template
    
    Parameters:
    
    context - The context object. May be null.
    
    writer - The writer object. Required.
    
    Throws:
    
    IOException - If a resource cannot be loaded.
  - apply
```
public String apply(Context context)
             throws IOException
```
    Description copied from interface: Template
    
    Merge the template tree using the given context.
    
    Specified by:
    
    apply in interface Template
    
    Parameters:
    
    context - The context object. Required.
    
    Returns:
    
    The resulting template.
    
    Throws:
    
    IOException - If a resource cannot be loaded.
  - apply
```
public void apply(Context context,
                  Writer writer)
           throws IOException
```
    Description copied from interface: Template
    
    Merge the template tree using the given context.
    
    Specified by:
    
    apply in interface Template
    
    Parameters:
    
    context - The context object. Required.
    
    writer - The writer object. Required.
    
    Throws:
    
    IOException - If a resource cannot be loaded.
  - before
```
public void before(Context context,
                   Writer writer)
            throws IOException
```
    Notify that template is going to be processed.
    
    Parameters:
    
    context - The context object. Required.
    
    writer - The writer object. Required.
    
    Throws:
    
    IOException - If a resource cannot be loaded.
  - after
```
public void after(Context context,
                  Writer writer)
           throws IOException
```
    Notify that template has been processed.
    
    Parameters:
    
    context - The context object. Required.
    
    writer - The writer object. Required.
    
    Throws:
    
    IOException - If a resource cannot be loaded.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - filename
```
public com.github.jknack.handlebars.internal.BaseTemplate filename(String filename)
```
    Set the file's name.
    
    Parameters:
    
    filename - The file's name.
    
    Returns:
    
    This template.
  - filename
```
public String filename()
```
    Specified by:
    
    filename in interface Template
    
    Returns:
    
    The template file's name.
  - position
```
public int[] position()
```
    Specified by:
    
    position in interface Template
    
    Returns:
    
    The line and column where the template was found.
  - position
```
public com.github.jknack.handlebars.internal.BaseTemplate position(int line,
                                                                   int column)
```
    Set the template position.
    
    Parameters:
    
    line - The line.
    
    column - The column.
    
    Returns:
    
    This template.
  - as
```
public <T,S extends TypeSafeTemplate<T>> S as(Class<S> rootType)
```
    Description copied from interface: Template
    
    Creates a new TypeSafeTemplate.
    
    Specified by:
    
    as in interface Template
    
    Type Parameters:
    
    T - The root type.
    
    S - The template type.
    
    Parameters:
    
    rootType - The template type. Required.
    
    Returns:
    
    A new TypeSafeTemplate.
  - as
```
public <T> TypeSafeTemplate<T> as()
```
    Description copied from interface: Template
    
    Creates a new TypeSafeTemplate.
    
    Specified by:
    
    as in interface Template
    
    Type Parameters:
    
    T - The root type.
    
    Returns:
    
    A new TypeSafeTemplate.
  - collect
```
public List<String> collect(TagType... tagType)
```
    Description copied from interface: Template
    Collect all the tag names under the given tagType.
    Usage:
```
 {{hello}}
 {{var 1}}
 {{{tripleVar}}}
 
```
    collect(TagType.VAR) returns [hello, var]
    
    collect(TagType.TRIPLE_VAR) returns [tripleVar]
    
    collect(TagType.VAR, TagType.TRIPLE_VAR) returns [hello, var, tripleVar]
    Specified by:
    
    collect in interface Template
    
    Parameters:
    
    tagType - The tag type. Required.
    
    Returns:
    
    A list with tag names.
  - collect
```
protected void collect(Collection<String> result,
                       TagType tagType)
```
    Child classes might want to check if they apply to the tagtype and append them self to the result list.
    
    Parameters:
    
    result - The result list.
    
    tagType - The matching tagtype.
  - collectReferenceParameters
```
public List<String> collectReferenceParameters()
```
    Description copied from interface: Template
    Collects all the parameters which are also variables.
    Usage:
```
 {{#if v1}}{{/if}}
 {{#each v2 "test"}}{{/each}}
 
```
    collectReferenceParameters() returns [v1, v2]
    Specified by:
    
    collectReferenceParameters in interface Template
    
    Returns:
    
    A list with reference parameter names.
  - collectReferenceParameters
```
protected void collectReferenceParameters(Collection<String> result)
```
    Parameters:
    
    result - The result list to add new parameters to.
  - toJavaScript
```
public String toJavaScript()
```
    Description copied from interface: Template
    
    Convert this template to JavaScript template (a.k.a precompiled template). Compilation is done by handlebars.js and a JS Engine (usually Rhino).
    
    Specified by:
    
    toJavaScript in interface Template
    
    Returns:
    
    A pre-compiled JavaScript version of this template.
  - decorate
```
public boolean decorate()
```
    Returns:
    
    True if this template has decorators.

Class PartialBlockForwardingTemplate

Field Summary

Fields inherited from interface com.github.jknack.handlebars.Template

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

handlebars

line

column

filename

Constructor Detail

PartialBlockForwardingTemplate

Method Detail

merge

text

apply

apply

apply

apply

before

after

toString

filename

filename

position

position

as

as

collect

collect

collectReferenceParameters

collectReferenceParameters

toJavaScript

decorate