Method Detail

• createCodeBuilder

  protected CodeBuilder<JsExpr> createCodeBuilder()

  Overrides:

  createCodeBuilder in class GenJsCodeVisitor

  Returns:

  A new CodeBuilder to create the contents of a file with.

• getJsCodeBuilder

  protected IncrementalDomCodeBuilder getJsCodeBuilder()

  Overrides:

  getJsCodeBuilder in class GenJsCodeVisitor

  Returns:

  The CodeBuilder used for generating file contents.

• 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.

• addCodeToRequireGeneralDeps

  protected void addCodeToRequireGeneralDeps(SoyFileNode soyFile)

  Description copied from class: GenJsCodeVisitor
  Helper for visitSoyFileNode(SoyFileNode) to add code to require general dependencies.

  Overrides:

  addCodeToRequireGeneralDeps in class GenJsCodeVisitor

  Parameters:

  soyFile - The node we're visiting.

• getJsTypeName

  protected String getJsTypeName(SoyType type)

  Description copied from class: GenJsCodeVisitor
  Returns the name of the JS type used to represent the given SoyType at runtime. Can be overridden by subclasses to provide a different mapping.

  Overrides:

  getJsTypeName in class GenJsCodeVisitor

• 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 void 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, this only occurs when we have something like:

   <div {if $condition}attr="value"{/if}>
   

  or in a let/param of kind attributes, e.g.

   {let $attrs kind="attributes"}
     attr="value"
   {/let}
   

  If no attributes are conditional, then the HtmlAttributeNode will be a child of the corresponding HtmlOpenTagNode/HtmlVoidTagNode and will not be visited directly. Note that the value itself could still be conditional in that case.

   <div disabled="{if $disabled}true{else}false{/if}">
   

  This method prints the attribute declaration calls. For example, it would print the call to iattr from the first example, resulting in:

   if (condition) {
     iattr(attr, "value");
   }
   

  Overrides:

  visitHtmlAttributeNode in class AbstractHtmlSoyNodeVisitor<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

   ie_open('div', null,
       'attr', 'value',
       'attr2', someVar);
   

  Overrides:

  visitHtmlOpenTagNode in class AbstractHtmlSoyNodeVisitor<List<String>>

• visitHtmlCloseTagNode

  protected void visitHtmlCloseTagNode(HtmlCloseTagNode node)

  Visits an HtmlCloseTagNode, which occurs when an HTML tag is closed. For example:

   </div>
   

  generates

   ie_close('div');
   

  Overrides:

  visitHtmlCloseTagNode in class AbstractHtmlSoyNodeVisitor<List<String>>

• visitHtmlOpenTagStartNode

  protected void visitHtmlOpenTagStartNode(HtmlOpenTagStartNode node)

  Visits an HtmlOpenTagStartNode, which occurs at the end of an open tag containing children that are not HtmlAttributeNodes. For example,

   <div {$attrs} attr="value">
   

  The opening bracket and tag translate to

   ie_open_start('div');
   

  Overrides:

  visitHtmlOpenTagStartNode in class AbstractHtmlSoyNodeVisitor<List<String>>

• visitHtmlOpenTagEndNode

  protected void visitHtmlOpenTagEndNode(HtmlOpenTagEndNode node)

  Visits an HtmlOpenTagEndNode, which occurs at the end of an open tag containing children that are not HtmlAttributeNodes. For example,

   <div {$attrs} attr="value">
   

  The closing bracket translates to

   ie_open_end();
   

  Overrides:

  visitHtmlOpenTagEndNode in class AbstractHtmlSoyNodeVisitor<List<String>>

• visitHtmlVoidTagNode

  protected void visitHtmlVoidTagNode(HtmlVoidTagNode node)

  Visits an HtmlVoidTagNode, which is equivalent to an HtmlOpenTagNode followed immediately by an HtmlCloseTagNode Example:

     <div attr="value" attr2="{$someVar}"></div>
   

  generates

     ie_void('div', null,
         'attr', 'value',
         'attr2', someVar);
   

  Overrides:

  visitHtmlVoidTagNode in class AbstractHtmlSoyNodeVisitor<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

   itext('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 itext, resulting in a Text node.

  Overrides:

  visitPrintNode in class GenJsCodeVisitor

• visitMsgFallbackGroupNode

  protected void visitMsgFallbackGroupNode(MsgFallbackGroupNode node)

  Overrides:

  visitMsgFallbackGroupNode in class GenJsCodeVisitor

• visitMsgHtmlTagNode

  protected void visitMsgHtmlTagNode(MsgHtmlTagNode node)

  Overrides:

  visitMsgHtmlTagNode in class GenJsCodeVisitor