TemplateEngine

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. def +(other: String): String

   

   Implicit information

   This member is added by an implicit conversion from TemplateEngine to any2stringadd[TemplateEngine] performed by method any2stringadd in scala.Predef.

   Definition Classes

   any2stringadd

4. def ->[B](y: B): (TemplateEngine, B)

   

   Implicit information

   This member is added by an implicit conversion from TemplateEngine to ArrowAssoc[TemplateEngine] performed by method ArrowAssoc in scala.Predef.

   Definition Classes

   ArrowAssoc

   Annotations

   @inline()

5. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

6. var allowCaching: Boolean

   

   Set to false if you don't want the template engine to ever cache any of the compiled templates.

   Set to false if you don't want the template engine to ever cache any of the compiled templates.

   If not explicitly configured this property can be configured using the scalate.allowCaching system property

7. var allowReload: Boolean

   

   If true, then the template engine will check to see if the template has been updated since last compiled so that it can be reloaded.

   If true, then the template engine will check to see if the template has been updated since last compiled so that it can be reloaded. Defaults to true. YOu should set to false in production environments since the templates should not be changing.

   If not explicitly configured this property can be configured using the scalate.allowReload system property

8. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

9. var bindings: List[Binding]

   

   By default lets bind the context so we get to reuse its methods in a template

10. def boot(): Unit

    

11. var bootClassName: String

    

12. var bootInjections: List[AnyRef]

    

13. def buildSourceMap(stratumName: String, uri: String, scalaFile: File, positions: TreeMap[OffsetPosition, OffsetPosition]): String

    

    Attributes

    protected

14. def bytecodeDirectory: File

    

15. def cacheHits: Int

    

    The number of times a template load request was serviced from the cache.

16. def cacheMisses: Int

    

    The number of times a template load request could not be serviced from the cache and was loaded from disk.

17. def canLoad(uri: String, extraBindings: Iterable[Binding]): Boolean

    

    Returns true if the URI can be loaded as a template

18. def canLoad(uri: String): Boolean

    

    Returns true if the URI can be loaded as a template

19. def canLoad(source: TemplateSource, extraBindings: Iterable[Binding] = Nil): Boolean

    

    Returns true if the URI can be loaded as a template

20. def classFileName(uri: String): File

    

    Attributes

    protected

21. var classLoader: ClassLoader

    

22. var classpath: String

    

23. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

24. var codeGenerators: Map[String, CodeGenerator]

    

    The supported template engines and their default extensions

25. var combinedClassPath: Boolean

    

    Whether a custom classpath should be combined with the deduced classpath

26. def compile(source: TemplateSource, extraBindings: Iterable[Binding] = Nil): Template

    

    Compiles a template source without placing it in the template cache.

    Compiles a template source without placing it in the template cache. Useful for temporary templates or dynamically created template

27. def compileMoustache(text: String, extraBindings: Iterable[Binding] = Nil): Template

    

    Compiles the given Moustache template text and returns the template

28. def compileScaml(text: String, extraBindings: Iterable[Binding] = Nil): Template

    

    Compiles the given SSP template text and returns the template

29. def compileSsp(text: String, extraBindings: Iterable[Binding] = Nil): Template

    

    Compiles the given SSP template text and returns the template

30. def compileText(extension: String, text: String, extraBindings: Iterable[Binding] = Nil): Template

    

    Compiles the given text using the given extension (such as ssp or scaml for example to denote what parser to use) and return the template

31. lazy val compiler: Compiler

    

32. var compilerInitialized: Boolean

    

33. def createCompiler: Compiler

    

    Factory method to create a compiler for this TemplateEngine.

    Factory method to create a compiler for this TemplateEngine. Override if you wish to contorl the compilation in a different way such as in side SBT or something.

    Attributes

    protected

34. def createRenderContext(uri: String, out: PrintWriter): RenderContext

    

    Factory method used by the layout helper methods that should be overloaded by template engine implementations if they wish to customize the render context implementation

    Factory method used by the layout helper methods that should be overloaded by template engine implementations if they wish to customize the render context implementation

    Attributes

    protected

35. def ensuring(cond: (TemplateEngine) ⇒ Boolean, msg: ⇒ Any): TemplateEngine

    

    Implicit information

    This member is added by an implicit conversion from TemplateEngine to Ensuring[TemplateEngine] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

36. def ensuring(cond: (TemplateEngine) ⇒ Boolean): TemplateEngine

    

    Implicit information

    This member is added by an implicit conversion from TemplateEngine to Ensuring[TemplateEngine] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

37. def ensuring(cond: Boolean, msg: ⇒ Any): TemplateEngine

    

    Implicit information

    This member is added by an implicit conversion from TemplateEngine to Ensuring[TemplateEngine] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

38. def ensuring(cond: Boolean): TemplateEngine

    

    Implicit information

    This member is added by an implicit conversion from TemplateEngine to Ensuring[TemplateEngine] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

39. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

40. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

41. var escapeMarkup: Boolean

    

    Whether or not markup sensitive characters for HTML/XML elements like & > < are escaped or not

42. def expireAndCompile(source: TemplateSource, extraBindings: Iterable[Binding] = Nil): Unit

    

    Expire specific template source and then compile and cache again

43. def extension(source: TemplateSource): Option[String]

    

    Extracts the extension from the source's uri though derived engines could override this behaviour to auto default missing extensions or performing custom mappings etc.

    Extracts the extension from the source's uri though derived engines could override this behaviour to auto default missing extensions or performing custom mappings etc.

    Attributes

    protected

44. var extensionToTemplateExtension: Map[String, Set[String]]

    

    Maps file extensions to possible template extensions for custom mappins such as for Map("js" -> Set("coffee"), "css" => Set("sass", "scss"))

45. def extensions: Set[String]

    

    Returns the file extensions understood by Scalate; all the template engines and pipelines including the wiki markup languages.

46. def filter(name: String): Option[Filter]

    

47. var filters: Map[String, Filter]

    

48. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

49. val finderCache: ConcurrentHashMap[String, String]

    

50. def formatted(fmtstr: String): String

    

    Implicit information

    This member is added by an implicit conversion from TemplateEngine to StringFormat[TemplateEngine] performed by method StringFormat in scala.Predef.

    Definition Classes

    StringFormat

    Annotations

    @inline()

51. def generateScala(uri: String): Code

    

    Generates the Scala code for a template.

    Generates the Scala code for a template. Useful for generating scala code that will then be compiled into the application as part of a build process.

52. def generateScala(uri: String, extraBindings: Iterable[Binding]): Code

    

    Generates the Scala code for a template.

    Generates the Scala code for a template. Useful for generating scala code that will then be compiled into the application as part of a build process.

53. def generateScala(source: TemplateSource, extraBindings: Iterable[Binding] = Nil): Code

    

    Generates the Scala code for a template.

    Generates the Scala code for a template. Useful for generating scala code that will then be compiled into the application as part of a build process.

54. def generator(source: TemplateSource): CodeGenerator

    

    Gets the code generator to use for the give uri string by looking up the uri's extension in the the codeGenerators map.

    Gets the code generator to use for the give uri string by looking up the uri's extension in the the codeGenerators map.

    Attributes

    protected

55. def generatorForExtension(extension: String): CodeGenerator

    

    Returns the code generator for the given file extension

    Returns the code generator for the given file extension

    Attributes

    protected

56. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

57. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

58. var importStatements: List[String]

    

    Sets the import statements used in each generated template class

59. def invalidateCachedTemplates(): Boolean

    

    Invalidates all cached Templates.

60. def isDevelopmentMode: Boolean

    

    Returns true if this template engine is being used in development mode.

61. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

62. def layout(source: TemplateSource, context: RenderContext): Unit

    

    Renders the given template source using the current layoutStrategy

63. def layout(source: TemplateSource, context: RenderContext, extraBindings: Iterable[Binding]): Unit

    

    Renders the given template source using the current layoutStrategy

64. def layout(source: TemplateSource, attributes: Map[String, Any]): String

    

    Renders the given template source using the current layoutStrategy

65. def layout(source: TemplateSource): String

    

    Renders the given template source using the current layoutStrategy

66. def layout(uri: String, template: Template): String

    

67. def layout(uri: String, context: RenderContext): Unit

    

68. def layout(uri: String, template: Template, attributes: Map[String, Any]): String

    

    Renders the given template returning the output

69. def layout(uri: String, template: Template, out: PrintWriter, attributes: Map[String, Any]): Unit

    

    Attributes

    protected

70. def layout(uri: String, out: PrintWriter, attributes: Map[String, Any]): Unit

    

71. def layout(uri: String, attributes: Map[String, Any] = Map(), extraBindings: Iterable[Binding] = Nil): String

    

    Renders the given template URI returning the output

72. def layout(template: Template, context: RenderContext): Unit

    

    Renders the given template using the current layoutStrategy

73. def layout(uri: String, context: RenderContext, extraBindings: Iterable[Binding]): Unit

    

    Renders the given template URI using the current layoutStrategy

74. def layoutAsNodes(uri: String, template: Template): NodeSeq

    

75. def layoutAsNodes(uri: String, template: Template, attributes: Map[String, Any]): NodeSeq

    

    Renders the given template returning the output

76. def layoutAsNodes(uri: String, attributes: Map[String, Any] = Map(), extraBindings: Iterable[Binding] = Nil): NodeSeq

    

    Renders the given template URI returning the output

77. var layoutStrategy: LayoutStrategy

    

78. def libraryDirectory: File

    

79. def load(uri: String): Template

    

    Compiles and then caches the specified template.

    Compiles and then caches the specified template. If the template was previously cached, the previously compiled template instance is returned. The cache entry in invalidated and then template is re-compiled if the template file has been updated since it was last compiled.

80. def load(uri: String, extraBindings: Iterable[Binding]): Template

    

    Compiles and then caches the specified template.

    Compiles and then caches the specified template. If the template was previously cached, the previously compiled template instance is returned. The cache entry in invalidated and then template is re-compiled if the template file has been updated since it was last compiled.

81. def load(file: File): Template

    

    Compiles and then caches the specified template.

    Compiles and then caches the specified template. If the template was previously cached, the previously compiled template instance is returned. The cache entry in invalidated and then template is re-compiled if the template file has been updated since it was last compiled.

82. def load(file: File, extraBindings: Iterable[Binding]): Template

    

    Compiles and then caches the specified template.

    Compiles and then caches the specified template. If the template was previously cached, the previously compiled template instance is returned. The cache entry in invalidated and then template is re-compiled if the template file has been updated since it was last compiled.

83. def load(source: TemplateSource, extraBindings: Iterable[Binding] = Nil): Template

    

    Compiles and then caches the specified template.

    Compiles and then caches the specified template. If the template was previously cached, the previously compiled template instance is returned. The cache entry in invalidated and then template is re-compiled if the template file has been updated since it was last compiled.

84. var mode: String

    

85. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

86. final def notify(): Unit

    

    Definition Classes

    AnyRef

87. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

88. var packagePrefix: String

    

89. def pipeline(source: TemplateSource): Option[List[Filter]]

    

    Gets a pipeline to use for the give uri string by looking up the uri's extension in the the pipelines map.

    Gets a pipeline to use for the give uri string by looking up the uri's extension in the the pipelines map.

    Attributes

    protected

90. var pipelines: Map[String, List[Filter]]

    

91. var resourceLoader: ResourceLoader

    

    Loads resources such as the templates based on URIs

92. def shutdown(): Unit

    

93. def source(uri: String, templateType: String): TemplateSource

    

    Returns a template source of the given type of template for the given URI and current resourceLoader

94. def source(uri: String): TemplateSource

    

    Returns a template source for the given URI and current resourceLoader

95. var sourceDirectories: Iterable[File]

    

96. def sourceDirectoriesForwarder: Iterable[File]

    

    A forwarder so we can refer to whatever the current latest value of sourceDirectories is even if the value is mutated after the TemplateEngine is constructed

    A forwarder so we can refer to whatever the current latest value of sourceDirectories is even if the value is mutated after the TemplateEngine is constructed

    Attributes

    protected

97. def sourceDirectory: File

    

98. def sourceFileName(uri: String): File

    

    Returns the source file of the template URI

    Returns the source file of the template URI

    Attributes

    protected

99. val sourceMapLog: Log

    

    Attributes

    protected

100. def storeSourceMap(classFile: File, sourceMap: String): Unit

     

     Attributes

     protected

101. final def synchronized[T0](arg0: ⇒ T0): T0

     

     Definition Classes

     AnyRef

102. var templateDirectories: List[String]

     

     A list of directories which are searched to load requested templates.

103. def templateExtensionsFor(extension: String): Set[String]

     

     Returns the mutable set of template extensions which are mapped to the given URI extension.

104. def tmpDirectory: File

     

105. def toString(): String

     

     Definition Classes

     TemplateEngine → AnyRef → Any

106. def uriToSource(uri: String): UriTemplateSource

     

     Creates a org.fusesource.scalate.TemplateSource from a URI

     Creates a org.fusesource.scalate.TemplateSource from a URI

     Attributes

     protected

107. final def wait(): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

108. final def wait(arg0: Long, arg1: Int): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

109. final def wait(arg0: Long): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

110. def workingDirectory: File

     

     If not explicitly configured this will default to using the scalate.workdir system property to specify the directory used for generating the scala source code and compiled bytecode - otherwise a temporary directory is used

111. def workingDirectory_=(value: File): Unit

     

112. def →[B](y: B): (TemplateEngine, B)

     

     Implicit information

     This member is added by an implicit conversion from TemplateEngine to ArrowAssoc[TemplateEngine] performed by method ArrowAssoc in scala.Predef.

     Definition Classes

     ArrowAssoc