SoyJsSrcOptions (Closure Templates)

java.lang.Object
- com.google.template.soy.jssrc.SoyJsSrcOptions

All Implemented Interfaces:

Cloneable
```
public final class SoyJsSrcOptions
extends Object
implements Cloneable
```
Compilation options for the JS Src output target (backend).

Constructor Summary

Constructors
Constructor and Description

SoyJsSrcOptions()

Constructors
Constructor and Description
`SoyJsSrcOptions()`

Method Summary

Methods
Modifier and Type	Method and Description
`SoyJsSrcOptions`	`clone()`
`int`	`getBidiGlobalDir()` Returns the static bidi global directionality, 1: ltr, -1: rtl, 0: unspecified.
`boolean`	`getUseGoogIsRtlForBidiGlobalDir()` Returns whether to determine the bidi global direction at template runtime by evaluating goog.i18n.bidi.IS_RTL.
`boolean`	`googMsgsAreExternal()` Returns whether the generated Closure Library message definitions are for external messages (only applicable if shouldGenerateGoogMsgDefs is true).
`void`	`setBidiGlobalDir(int bidiGlobalDir)` Sets the bidi global directionality to a static value, 1: ltr, -1: rtl, 0: unspecified.
`void`	`setGoogMsgsAreExternal(boolean googMsgsAreExternal)` Sets whether the generated Closure Library message definitions are for external messages (only applicable if shouldGenerateGoogMsgDefs is true).
`void`	`setShouldAllowDeprecatedSyntax(boolean shouldAllowDeprecatedSyntax)` Sets whether to allow deprecated syntax (semi backwards compatible mode).
`void`	`setShouldDeclareTopLevelNamespaces(boolean shouldDeclareTopLevelNamespaces)` Sets whether we should generate code to declare the top level namespace.
`void`	`setShouldGenerateGoogModules(boolean shouldGenerateGoogModules)` Sets whether goog.modules should be generated.
`void`	`setShouldGenerateGoogMsgDefs(boolean shouldGenerateGoogMsgDefs)` Sets whether we should generate Closure Library message definitions (i.e.
`void`	`setShouldGenerateJsdoc(boolean shouldGenerateJsdoc)` Sets whether we should generate JSDoc with type info for the Closure Compiler.
`void`	`setShouldProvideBothSoyNamespacesAndJsFunctions(boolean shouldProvideBothSoyNamespacesAndJsFunctions)` Sets whether we should generate code to provide both Soy namespaces and JS functions.
`void`	`setShouldProvideRequireJsFunctions(boolean shouldProvideRequireJsFunctions)` Sets whether we should generate code to provide/require template JS functions.
`void`	`setShouldProvideRequireSoyNamespaces(boolean shouldProvideRequireSoyNamespaces)` Sets whether we should generate code to provide/require Soy namespaces.
`void`	`setUseGoogIsRtlForBidiGlobalDir(boolean useGoogIsRtlForBidiGlobalDir)` Sets the Javascript code snippet that will evaluate at template runtime to a boolean value indicating whether the bidi global direction is rtl.
`boolean`	`shouldAllowDeprecatedSyntax()` Deprecated. Use `SoyGeneralOptions.getDeclaredSyntaxVersion()`.
`boolean`	`shouldDeclareTopLevelNamespaces()` Returns whether we should attempt to declare the top level namespace.
`boolean`	`shouldGenerateGoogModules()` Returns whether goog.modules should be generated.
`boolean`	`shouldGenerateGoogMsgDefs()` Returns whether we should generate Closure Library message definitions (i.e.
`boolean`	`shouldGenerateJsdoc()` Returns whether we should generate JSDoc with type info for the Closure Compiler.
`boolean`	`shouldProvideBothSoyNamespacesAndJsFunctions()` Returns whether we should generate code to provide both Soy namespaces and JS functions.
`boolean`	`shouldProvideRequireJsFunctions()` Returns whether we're set to generate code to provide/require template JS functions.
`boolean`	`shouldProvideRequireSoyNamespaces()` Returns whether we're set to generate code to provide/require Soy namespaces.

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

- Constructor Detail
  - SoyJsSrcOptions
```
public SoyJsSrcOptions()
```
- Method Detail
  - setShouldAllowDeprecatedSyntax
```
public void setShouldAllowDeprecatedSyntax(boolean shouldAllowDeprecatedSyntax)
```
    Sets whether to allow deprecated syntax (semi backwards compatible mode).
    
    Parameters:
    shouldAllowDeprecatedSyntax - The value to set.
  - shouldAllowDeprecatedSyntax
```
@Deprecated
public boolean shouldAllowDeprecatedSyntax()
```
    Deprecated. Use SoyGeneralOptions.getDeclaredSyntaxVersion().
    
    Returns whether we're set to allow deprecated syntax (semi backwards compatible mode).
  - setShouldGenerateJsdoc
```
public void setShouldGenerateJsdoc(boolean shouldGenerateJsdoc)
```
    Sets whether we should generate JSDoc with type info for the Closure Compiler.
    
    Parameters:
    shouldGenerateJsdoc - The value to set.
  - shouldGenerateJsdoc
```
public boolean shouldGenerateJsdoc()
```
    Returns whether we should generate JSDoc with type info for the Closure Compiler.
  - setShouldProvideRequireSoyNamespaces
```
public void setShouldProvideRequireSoyNamespaces(boolean shouldProvideRequireSoyNamespaces)
```
    Sets whether we should generate code to provide/require Soy namespaces.
    
    Parameters:
    shouldProvideRequireSoyNamespaces - The value to set.
  - shouldProvideRequireSoyNamespaces
```
public boolean shouldProvideRequireSoyNamespaces()
```
    Returns whether we're set to generate code to provide/require Soy namespaces.
  - setShouldProvideRequireJsFunctions
```
public void setShouldProvideRequireJsFunctions(boolean shouldProvideRequireJsFunctions)
```
    Sets whether we should generate code to provide/require template JS functions.
    
    Parameters:
    shouldProvideRequireJsFunctions - The value to set.
  - shouldProvideRequireJsFunctions
```
public boolean shouldProvideRequireJsFunctions()
```
    Returns whether we're set to generate code to provide/require template JS functions.
  - setShouldProvideBothSoyNamespacesAndJsFunctions
```
public void setShouldProvideBothSoyNamespacesAndJsFunctions(boolean shouldProvideBothSoyNamespacesAndJsFunctions)
```
    Sets whether we should generate code to provide both Soy namespaces and JS functions.
    
    Parameters:
    shouldProvideBothSoyNamespacesAndJsFunctions - The value to set.
  - shouldProvideBothSoyNamespacesAndJsFunctions
```
public boolean shouldProvideBothSoyNamespacesAndJsFunctions()
```
    Returns whether we should generate code to provide both Soy namespaces and JS functions.
  - setShouldDeclareTopLevelNamespaces
```
public void setShouldDeclareTopLevelNamespaces(boolean shouldDeclareTopLevelNamespaces)
```
    Sets whether we should generate code to declare the top level namespace.
    
    Parameters:
    shouldDeclareTopLevelNamespaces - The value to set.
  - shouldDeclareTopLevelNamespaces
```
public boolean shouldDeclareTopLevelNamespaces()
```
    Returns whether we should attempt to declare the top level namespace.
  - setShouldGenerateGoogModules
```
public void setShouldGenerateGoogModules(boolean shouldGenerateGoogModules)
```
    Sets whether goog.modules should be generated.
    
    Parameters:
    shouldGenerateGoogModules - The value to set.
  - shouldGenerateGoogModules
```
public boolean shouldGenerateGoogModules()
```
    Returns whether goog.modules should be generated.
  - setShouldGenerateGoogMsgDefs
```
public void setShouldGenerateGoogMsgDefs(boolean shouldGenerateGoogMsgDefs)
```
    Sets whether we should generate Closure Library message definitions (i.e. goog.getMsg).
    
    Parameters:
    shouldGenerateGoogMsgDefs - The value to set.
  - shouldGenerateGoogMsgDefs
```
public boolean shouldGenerateGoogMsgDefs()
```
    Returns whether we should generate Closure Library message definitions (i.e. goog.getMsg).
  - setGoogMsgsAreExternal
```
public void setGoogMsgsAreExternal(boolean googMsgsAreExternal)
```
    Sets whether the generated Closure Library message definitions are for external messages (only applicable if shouldGenerateGoogMsgDefs is true). If this option is true, then we generate var MSG_EXTERNAL_[soyGeneratedMsgId] = goog.getMsg(...); If this option is false, then we generate var MSG_UNNAMED_[uniquefier] = goog.getMsg(...);
    
    Parameters:
    googMsgsAreExternal - The value to set.
  - googMsgsAreExternal
```
public boolean googMsgsAreExternal()
```
    Returns whether the generated Closure Library message definitions are for external messages (only applicable if shouldGenerateGoogMsgDefs is true). If this option is true, then we generate var MSG_EXTERNAL_[soyGeneratedMsgId] = goog.getMsg(...); If this option is false, then we generate var MSG_UNNAMED_[uniquefier] = goog.getMsg(...);
  - setBidiGlobalDir
```
public void setBidiGlobalDir(int bidiGlobalDir)
```
    Sets the bidi global directionality to a static value, 1: ltr, -1: rtl, 0: unspecified. If 0, and useGoogIsRtlForBidiGlobalDir is false, the bidi global directionality will actually be inferred from the message bundle locale. This is the recommended mode of operation when shouldGenerateGoogMsgDefs is false. When shouldGenerateGoogMsgDefs is true, the bidi global direction can not be left unspecified, but the recommended way of doing so is via setUseGoogIsRtlForBidiGlobalDir(true). Thus, whether shouldGenerateGoogMsgDefs is true or not, THERE IS USUALLY NO NEED TO USE THIS METHOD!
    
    Parameters:
    bidiGlobalDir - 1: ltr, -1: rtl, 0: unspecified. Checks that no other value is used.
  - getBidiGlobalDir
```
public int getBidiGlobalDir()
```
    Returns the static bidi global directionality, 1: ltr, -1: rtl, 0: unspecified.
  - setUseGoogIsRtlForBidiGlobalDir
```
public void setUseGoogIsRtlForBidiGlobalDir(boolean useGoogIsRtlForBidiGlobalDir)
```
    Sets the Javascript code snippet that will evaluate at template runtime to a boolean value indicating whether the bidi global direction is rtl. Can only be used when shouldGenerateGoogMsgDefs is true.
    
    Parameters:
    useGoogIsRtlForBidiGlobalDir - Whether to determine the bidi global direction at template runtime by evaluating goog.i18n.bidi.IS_RTL.
  - getUseGoogIsRtlForBidiGlobalDir
```
public boolean getUseGoogIsRtlForBidiGlobalDir()
```
    Returns whether to determine the bidi global direction at template runtime by evaluating goog.i18n.bidi.IS_RTL. May only be true when shouldGenerateGoogMsgDefs is true.
  - clone
```
public final SoyJsSrcOptions clone()
```
    Overrides:
    
    clone in class Object

Class SoyJsSrcOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SoyJsSrcOptions

Method Detail

setShouldAllowDeprecatedSyntax

shouldAllowDeprecatedSyntax

setShouldGenerateJsdoc

shouldGenerateJsdoc

setShouldProvideRequireSoyNamespaces

shouldProvideRequireSoyNamespaces

setShouldProvideRequireJsFunctions

shouldProvideRequireJsFunctions

setShouldProvideBothSoyNamespacesAndJsFunctions

shouldProvideBothSoyNamespacesAndJsFunctions

setShouldDeclareTopLevelNamespaces

shouldDeclareTopLevelNamespaces

setShouldGenerateGoogModules

shouldGenerateGoogModules

setShouldGenerateGoogMsgDefs

shouldGenerateGoogMsgDefs

setGoogMsgsAreExternal

googMsgsAreExternal

setBidiGlobalDir

getBidiGlobalDir

setUseGoogIsRtlForBidiGlobalDir

getUseGoogIsRtlForBidiGlobalDir

clone