GenIncrementalDomCodeVisitor (Closure Templates)

java.lang.Object
- com.google.template.soy.basetree.AbstractNodeVisitor<SoyNode,R>
- - com.google.template.soy.soytree.AbstractSoyNodeVisitor<List<String>>
  - - com.google.template.soy.jssrc.internal.GenJsCodeVisitor
    - - com.google.template.soy.incrementaldomsrc.GenIncrementalDomCodeVisitor

All Implemented Interfaces:

NodeVisitor<SoyNode,List<String>>
```
public final class GenIncrementalDomCodeVisitor
extends GenJsCodeVisitor
```
Generates a series of JavaScript control statements and function calls for rendering one or more templates as HTML. This heavily leverages GenJsCodeVisitor, adding logic to print the function calls and changing how statements are combined.

Field Summary
- Fields inherited from class com.google.template.soy.jssrc.internal.GenJsCodeVisitor
  errorReporter, genCallCodeUtils, genJsExprsVisitor, isComputableAsJsExprsVisitor, jsSrcOptions, templateAliases, templateRegistry, templateTranslationContext

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected com.google.template.soy.incrementaldomsrc.IncrementalDomCodeBuilder`	`createChildJsCodeBuilder()`
`protected JsCodeBuilder`	`createCodeBuilder()`
`protected CodeChunk`	`generateFunctionBody(TemplateNode node)` Generates the function body.
`protected String`	`getGoogModuleNamespace(String soyNamespace)` Changes module namespaces, adding an extension of '.incrementaldom' to allow it to co-exist with templates generated by jssrc.
`protected com.google.template.soy.incrementaldomsrc.IncrementalDomCodeBuilder`	`getJsCodeBuilder()`
`protected String`	`getTemplateReturnType(TemplateNode node)`
`protected void`	`visit(SoyNode node)` Visits the given node to execute the function defined by this visitor.
`protected void`	`visitCallNode(CallNode node)` Example:
`protected void`	`visitCallParamContentNode(CallParamContentNode node)`
`protected void`	`visitChildren(SoyNode.ParentSoyNode<?> node)` Visits the children of a ParentSoyNode.
`protected void`	`visitHtmlAttributeNode(HtmlAttributeNode node)` Visits the `HtmlAttributeNode`.
`protected void`	`visitHtmlAttributeValueNode(HtmlAttributeValueNode node)`
`protected void`	`visitHtmlCloseTagNode(HtmlCloseTagNode node)` Visits an `HtmlCloseTagNode`, which occurs when an HTML tag is closed.
`protected void`	`visitHtmlOpenTagNode(HtmlOpenTagNode node)` Visits an `HtmlOpenTagNode`, which occurs when an HTML tag is opened with no conditional attributes.
`protected void`	`visitIfNode(IfNode node)` Generates calls in HTML/Attributes content as non-JsExprs, since Incremental DOM instructions are needed and not a JavaScript expression.
`protected void`	`visitLetContentNode(LetContentNode node)` Generates the content of a `let` statement.
`protected void`	`visitMsgFallbackGroupNode(MsgFallbackGroupNode node)`
`protected void`	`visitMsgHtmlTagNode(MsgHtmlTagNode node)`
`protected void`	`visitPrintNode(PrintNode node)` Visit an `PrintNode`, with special cases for a variable being printed within an attribute declaration or as HTML content.
`protected void`	`visitRawTextNode(RawTextNode node)` Visits a `RawTextNode`, which occurs either as a child of any BlockNode or the 'child' of an HTML tag.
`protected void`	`visitTemplateNode(TemplateNode node)` Outputs a `TemplateNode`, generating the function open and close, along with a a debug template name.
`protected void`	`visitVeLogNode(VeLogNode node)`

Methods inherited from class com.google.template.soy.jssrc.internal.GenJsCodeVisitor
exec, gen, generateNonExpressionIfNode, genParamTypeChecks, getAssistantForMsgs, sanitize, visitChildrenReturningCodeChunk, visitDebuggerNode, visitForNode, visitForNonemptyNode, visitForUseByAssistants, visitForUseByAssistantsAsCodeChunk, visitLetValueNode, visitLogNode, visitSoyFileNode, visitSoyFileSetNode, visitSoyNode, visitSwitchNode

Methods inherited from class com.google.template.soy.basetree.AbstractNodeVisitor
visitChildren, visitChildrenAllowingConcurrentModification

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

- Method Detail
  - createCodeBuilder
```
protected JsCodeBuilder createCodeBuilder()
```
    Overrides:
    
    createCodeBuilder in class GenJsCodeVisitor
    
    Returns:
    
    A new CodeBuilder to create the contents of a file with.
  - createChildJsCodeBuilder
```
protected com.google.template.soy.incrementaldomsrc.IncrementalDomCodeBuilder createChildJsCodeBuilder()
```
    Overrides:
    
    createChildJsCodeBuilder in class GenJsCodeVisitor
    
    Returns:
    
    A child CodeBuilder that inherits from the current builder.
  - getJsCodeBuilder
```
protected com.google.template.soy.incrementaldomsrc.IncrementalDomCodeBuilder getJsCodeBuilder()
```
    Overrides:
    
    getJsCodeBuilder in class GenJsCodeVisitor
    
    Returns:
    
    The CodeBuilder used for generating file contents.
  - visit
```
protected void visit(SoyNode node)
```
    Description copied from class: AbstractNodeVisitor
    
    Visits the given node to execute the function defined by this visitor.
    
    Overrides:
    
    visit in class AbstractSoyNodeVisitor<List<String>>
    
    Parameters:
    
    node - The node to visit.
  - getGoogModuleNamespace
```
protected String getGoogModuleNamespace(String soyNamespace)
```
    Changes module namespaces, adding an extension of '.incrementaldom' to allow it to co-exist with templates generated by jssrc.
    
    Overrides:
    
    getGoogModuleNamespace in class GenJsCodeVisitor
    
    Parameters:
    
    soyNamespace - The namespace as declared by the user.
    
    Returns:
    
    The namespace to import/export templates.
  - getTemplateReturnType
```
protected String getTemplateReturnType(TemplateNode node)
```
    Overrides:
    
    getTemplateReturnType in class GenJsCodeVisitor
    
    Parameters:
    
    node - The template node that is being generated
    
    Returns:
    
    The JavaScript type of the content generated by this template.
  - visitTemplateNode
```
protected void visitTemplateNode(TemplateNode node)
```
    Description copied from class: GenJsCodeVisitor
    Outputs a TemplateNode, generating the function open and close, along with a a debug template name.
    If aliasing is not performed (which is always the case for V1 templates), this looks like:
```
 my.namespace.func = function(opt_data, opt_sb) {
   ...
 };
 if (goog.DEBUG) {
   my.namespace.func.soyTemplateName = 'my.namespace.func';
 }
 
```
    If aliasing is performed, this looks like:
```
 function $func(opt_data, opt_sb) {
   ...
 }
 exports.func = $func;
 if (goog.DEBUG) {
   $func.soyTemplateName = 'my.namespace.func';
 }
 Note that the alias is not exactly the function name as in may conflict with a reserved
 JavaScript identifier.
 
```
    Overrides:
    
    visitTemplateNode in class GenJsCodeVisitor
  - generateFunctionBody
```
protected CodeChunk generateFunctionBody(TemplateNode node)
```
    Description copied from class: GenJsCodeVisitor
    
    Generates the function body.
    
    Overrides:
    
    generateFunctionBody in class GenJsCodeVisitor
  - visitChildren
```
protected void visitChildren(SoyNode.ParentSoyNode<?> node)
```
    Visits the children of a ParentSoyNode. This function is overridden to not do all of the work that GenJsCodeVisitor does.
    
    Overrides:
    
    visitChildren in class GenJsCodeVisitor
    
    Parameters:
    
    node - The parent node whose children to visit.
    
    See Also:
    
    AbstractSoyNodeVisitor.visitChildrenAllowingConcurrentModification(com.google.template.soy.soytree.SoyNode.ParentSoyNode<?>)
  - visitLetContentNode
```
protected void visitLetContentNode(LetContentNode node)
```
    Generates the content of a let statement. For HTML and attribute let statements, the generated instructions inside the node are wrapped in a function which will be optionally passed to another template and invoked in the correct location. All other kinds of let/param statements are generated as a simple variable.
    
    Overrides:
    
    visitLetContentNode in class GenJsCodeVisitor
  - visitCallParamContentNode
```
protected void visitCallParamContentNode(CallParamContentNode node)
```
    Overrides:
    
    visitCallParamContentNode in class GenJsCodeVisitor
  - visitCallNode
```
protected void visitCallNode(CallNode node)
```
    Description copied from class: GenJsCodeVisitor
    Example:
```
   {call some.func data="all" /}
   {call some.func data="$boo.foo" /}
   {call some.func}
     {param goo: 88 /}
   {/call}
   {call some.func data="$boo"}
     {param goo}
       Hello {$name}
     {/param}
   {/call}
 
```
    might generate
```
   output += some.func(opt_data);
   output += some.func(opt_data.boo.foo);
   output += some.func({goo: 88});
   output += some.func(soy.$$assignDefaults({goo: 'Hello ' + opt_data.name}, opt_data.boo);
 
```
    Overrides:
    
    visitCallNode in class GenJsCodeVisitor
  - visitIfNode
```
protected void visitIfNode(IfNode node)
```
    Generates calls in HTML/Attributes content as non-JsExprs, since Incremental DOM instructions are needed and not a JavaScript expression.
    
    Overrides:
    
    visitIfNode in class GenJsCodeVisitor
  - visitHtmlAttributeNode
```
protected void visitHtmlAttributeNode(HtmlAttributeNode node)
```
    Visits the HtmlAttributeNode. The attribute nodes will typically be children of the corresponding HtmlOpenTagNode or in a let/param of kind attributes, e.g.
```
 {let $attrs kind="attributes"}
   attr="value"
 {/let}
 
```
    This method prints the attribute declaration calls. For example, given
```
 <div {if $condition}attr="value"{/if}>
 
```
    it would print the call to incrementalDom.attr, resulting in:
```
 if (condition) {
   IncrementalDom.attr(attr, "value");
 }
 
```
    Overrides:
    
    visitHtmlAttributeNode in class AbstractSoyNodeVisitor<List<String>>
  - visitHtmlAttributeValueNode
```
protected void visitHtmlAttributeValueNode(HtmlAttributeValueNode node)
```
    Overrides:
    
    visitHtmlAttributeValueNode in class AbstractSoyNodeVisitor<List<String>>
  - visitHtmlOpenTagNode
```
protected void visitHtmlOpenTagNode(HtmlOpenTagNode node)
```
    Visits an HtmlOpenTagNode, which occurs when an HTML tag is opened with no conditional attributes. For example:
```
 <div attr="value" attr2="{$someVar}">...</div>
 
```
    generates
```
 IncrementalDom.elementOpen('div');
 IncrementalDom.attr('attr', 'value');
 IncrementalDom.attr('attr2', someVar);
 IncrementalDom.elementClose();
 
```
    Overrides:
    
    visitHtmlOpenTagNode in class AbstractSoyNodeVisitor<List<String>>
  - visitHtmlCloseTagNode
```
protected void visitHtmlCloseTagNode(HtmlCloseTagNode node)
```
    Visits an HtmlCloseTagNode, which occurs when an HTML tag is closed. For example:
```
 </div>
 
```
    generates
```
 incrementalDom.elementClose('div');
 
```
    Overrides:
    
    visitHtmlCloseTagNode in class AbstractSoyNodeVisitor<List<String>>
  - visitRawTextNode
```
protected void visitRawTextNode(RawTextNode node)
```
    Visits a RawTextNode, which occurs either as a child of any BlockNode or the 'child' of an HTML tag. Note that in the soy tree, tags and their logical HTML children do not have a parent-child relationship, but are rather siblings. For example:
```
 <div>Hello world</div>
 
```
    The text "Hello world" translates to
```
 incrementalDom.text('Hello world');
 
```
    Overrides:
    
    visitRawTextNode in class AbstractSoyNodeVisitor<List<String>>
  - visitPrintNode
```
protected void visitPrintNode(PrintNode node)
```
    Visit an PrintNode, with special cases for a variable being printed within an attribute declaration or as HTML content.
    For attributes, if the variable is of kind attributes, it is invoked. Any other kind of variable is an error.
    For HTML, if the variable is of kind HTML, it is invoked. Any other kind of variable gets wrapped in a call to incrementalDom.text, resulting in a Text node.
    
    Overrides:
    
    visitPrintNode in class GenJsCodeVisitor
  - visitVeLogNode
```
protected void visitVeLogNode(VeLogNode node)
```
    Overrides:
    
    visitVeLogNode in class AbstractSoyNodeVisitor<List<String>>
  - visitMsgFallbackGroupNode
```
protected void visitMsgFallbackGroupNode(MsgFallbackGroupNode node)
```
    Overrides:
    
    visitMsgFallbackGroupNode in class GenJsCodeVisitor
  - visitMsgHtmlTagNode
```
protected void visitMsgHtmlTagNode(MsgHtmlTagNode node)
```
    Overrides:
    
    visitMsgHtmlTagNode in class GenJsCodeVisitor

Class GenIncrementalDomCodeVisitor

Field Summary

Fields inherited from class com.google.template.soy.jssrc.internal.GenJsCodeVisitor

Method Summary

Methods inherited from class com.google.template.soy.jssrc.internal.GenJsCodeVisitor

Methods inherited from class com.google.template.soy.soytree.AbstractSoyNodeVisitor

Methods inherited from class com.google.template.soy.basetree.AbstractNodeVisitor

Methods inherited from class java.lang.Object

Method Detail

createCodeBuilder

createChildJsCodeBuilder

getJsCodeBuilder

visit

getGoogModuleNamespace

getTemplateReturnType

visitTemplateNode

generateFunctionBody

visitChildren

visitLetContentNode

visitCallParamContentNode

visitCallNode

visitIfNode

visitHtmlAttributeNode

visitHtmlAttributeValueNode

visitHtmlOpenTagNode

visitHtmlCloseTagNode

visitRawTextNode

visitPrintNode

visitVeLogNode

visitMsgFallbackGroupNode

visitMsgHtmlTagNode