org.fusesource.scalate.TemplateEngine

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

TemplateEngine
AnyRef
Any

Visibility

Public
All

Instance Constructors

new TemplateEngine (sourceDirectories: Traversable[File], mode: String)

Value Members

def != (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def != (arg0: Any): Boolean

Attributes
final
Definition Classes
Any
def ## (): Int

Attributes
final
Definition Classes
AnyRef → Any
def == (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def == (arg0: Any): Boolean

Attributes
final
Definition Classes
Any
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
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
def asInstanceOf [T0] : T0

Attributes
final
Definition Classes
Any
var bindings : List[Binding]

By default lets bind the context so we get to reuse its methods in a template
def boot : Unit
var bootClassName : String
var bootInjections : List[AnyRef]
def buildSourceMap (stratumName: String, uri: String, scalaFile: File, positions: TreeMap[OffsetPosition, OffsetPosition]): String

Attributes
protected
def bytecodeDirectory : File
def cacheHits : Int

The number of times a template load request was serviced from the cache.
def cacheMisses : Int

The number of times a template load request could not be serviced from the cache and was loaded from disk.
def canLoad (uri: String, extraBindings: List[Binding]): Boolean

Returns true if the URI can be loaded as a template
def canLoad (uri: String): Boolean

Returns true if the URI can be loaded as a template
def canLoad (source: TemplateSource, extraBindings: List[Binding] = Nil): Boolean

Returns true if the URI can be loaded as a template
def classFileName (uri: String): File

Attributes
protected
var classLoader : ClassLoader
var classpath : String
def clone (): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
var codeGenerators : Map[String, CodeGenerator]

The supported template engines and their default extensions
var combinedClassPath : Boolean

Whether a custom classpath should be combined with the deduced classpath
def compile (source: TemplateSource, extraBindings: List[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
def compileMoustache (text: String, extraBindings: List[Binding] = Nil): Template

Compiles the given Moustache template text and returns the template
def compileScaml (text: String, extraBindings: List[Binding] = Nil): Template

Compiles the given SSP template text and returns the template
def compileSsp (text: String, extraBindings: List[Binding] = Nil): Template

Compiles the given SSP template text and returns the template
def compileText (extension: String, text: String, extraBindings: List[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
lazy val compiler : ScalaCompiler
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
def eq (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def equals (arg0: Any): Boolean

Definition Classes
AnyRef → Any
var escapeMarkup : Boolean

Whether or not markup sensitive characters for HTML/XML elements like & > < are escaped or not
Whether or not markup sensitive characters for HTML/XML elements like & > < are escaped or not
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
def extensions : Set[String]

Returns the file extensions understood by Scalate; all the template engines and pipelines including the wiki markup languages.
def filter (name: String): Option[Filter]
var filters : Map[String, Filter]
def finalize (): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
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.
def generateScala (uri: String, extraBindings: List[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.
def generateScala (source: TemplateSource, extraBindings: List[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.
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
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
def getClass (): java.lang.Class[_]

Attributes
final
Definition Classes
AnyRef
def hashCode (): Int

Definition Classes
AnyRef → Any
var importStatements : List[String]

Sets the import statements used in each generated template class
def invalidateCachedTemplates (): Boolean

Invalidates all cached Templates.
def isDevelopmentMode : Boolean

Returns true if this template engine is being used in development mode.
def isInstanceOf [T0] : Boolean

Attributes
final
Definition Classes
Any
def layout (source: TemplateSource, context: RenderContext): Unit

Renders the given template source using the current layoutStrategy
def layout (source: TemplateSource, context: RenderContext, extraBindings: List[Binding]): Unit

Renders the given template source using the current layoutStrategy
def layout (source: TemplateSource, attributes: Map[String, Any]): String

Renders the given template source using the current layoutStrategy
def layout (source: TemplateSource): String

Renders the given template source using the current layoutStrategy
def layout (uri: String, template: Template): String
def layout (uri: String, context: RenderContext): Unit
def layout (uri: String, template: Template, attributes: Map[String, Any]): String

Renders the given template returning the output
def layout (uri: String, attributes: Map[String, Any] = Map(), extraBindings: List[Binding] = Nil): String

Renders the given template URI returning the output
def layout (template: Template, context: RenderContext): Unit

Renders the given template using the current layoutStrategy
def layout (uri: String, context: RenderContext, extraBindings: List[Binding]): Unit

Renders the given template URI using the current layoutStrategy
def layoutAsNodes (uri: String, template: Template): NodeSeq
def layoutAsNodes (uri: String, template: Template, attributes: Map[String, Any]): NodeSeq

Renders the given template returning the output
def layoutAsNodes (uri: String, attributes: Map[String, Any] = Map(), extraBindings: List[Binding] = Nil): NodeSeq

Renders the given template URI returning the output
var layoutStrategy : LayoutStrategy
def libraryDirectory : File
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.
def load (uri: String, extraBindings: List[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.
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.
def load (file: File, extraBindings: List[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.
def load (source: TemplateSource, extraBindings: List[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.
var mode : String
def ne (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def notify (): Unit

Attributes
final
Definition Classes
AnyRef
def notifyAll (): Unit

Attributes
final
Definition Classes
AnyRef
var packagePrefix : String
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
var pipelines : Map[String, List[Filter]]
var resourceLoader : ResourceLoader

Loads resources such as the templates based on URIs
def source (uri: String, templateType: String): TemplateSource

Returns a template source of the given type of template for the given URI and current resourceLoader
def source (uri: String): TemplateSource

Returns a template source for the given URI and current resourceLoader
var sourceDirectories : Traversable[File]
def sourceDirectoriesForwarder : TraversableForwarder[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
def sourceDirectory : File
def sourceFileName (uri: String): File

Returns the source file of the template URI
Returns the source file of the template URI

Attributes
protected
val sourceMapLog : Log

Attributes
protected
def storeSourceMap (classFile: File, sourceMap: String): Unit

Attributes
protected
def synchronized [T0] (arg0: ⇒ T0): T0

Attributes
final
Definition Classes
AnyRef
var templateDirectories : List[String]

A list of directories which are searched to load requested templates.
def tmpDirectory : File
def toString (): String

Definition Classes
TemplateEngine → AnyRef → Any
def uriToSource (uri: String): UriTemplateSource

Creates a TemplateSource from a URI
Creates a TemplateSource from a URI

Attributes
protected
def wait (): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
def wait (arg0: Long, arg1: Int): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
def wait (arg0: Long): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
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
def workingDirectory_= (value: File): Unit

TemplateEngine

class TemplateEngine extends AnyRef

Instance Constructors

new TemplateEngine (sourceDirectories: Traversable[File], mode: String)

Value Members

def != (arg0: AnyRef): Boolean

def != (arg0: Any): Boolean

def ## (): Int

def == (arg0: AnyRef): Boolean

def == (arg0: Any): Boolean

var allowCaching : Boolean

var allowReload : Boolean

def asInstanceOf [T0] : T0

var bindings : List[Binding]

def boot : Unit

var bootClassName : String

var bootInjections : List[AnyRef]

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

def bytecodeDirectory : File

def cacheHits : Int

def cacheMisses : Int

def canLoad (uri: String, extraBindings: List[Binding]): Boolean

def canLoad (uri: String): Boolean

def canLoad (source: TemplateSource, extraBindings: List[Binding] = Nil): Boolean

def classFileName (uri: String): File

var classLoader : ClassLoader

var classpath : String

def clone (): AnyRef

var codeGenerators : Map[String, CodeGenerator]

var combinedClassPath : Boolean

def compile (source: TemplateSource, extraBindings: List[Binding] = Nil): Template

def compileMoustache (text: String, extraBindings: List[Binding] = Nil): Template

def compileScaml (text: String, extraBindings: List[Binding] = Nil): Template

def compileSsp (text: String, extraBindings: List[Binding] = Nil): Template

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

lazy val compiler : ScalaCompiler

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

def eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

var escapeMarkup : Boolean

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

def extensions : Set[String]

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

var filters : Map[String, Filter]

def finalize (): Unit

def generateScala (uri: String): Code

def generateScala (uri: String, extraBindings: List[Binding]): Code

def generateScala (source: TemplateSource, extraBindings: List[Binding] = Nil): Code

def generator (source: TemplateSource): CodeGenerator

def generatorForExtension (extension: String): CodeGenerator

def getClass (): java.lang.Class[_]

def hashCode (): Int

var importStatements : List[String]

def invalidateCachedTemplates (): Boolean

def isDevelopmentMode : Boolean

def isInstanceOf [T0] : Boolean

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

def layout (source: TemplateSource, context: RenderContext, extraBindings: List[Binding]): Unit

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

def layout (source: TemplateSource): String

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

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

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

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

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

def layout (uri: String, context: RenderContext, extraBindings: List[Binding]): Unit

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

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

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

var layoutStrategy : LayoutStrategy

def libraryDirectory : File

def load (uri: String): Template

def load (uri: String, extraBindings: List[Binding]): Template

def load (file: File): Template

def load (file: File, extraBindings: List[Binding]): Template

def load (source: TemplateSource, extraBindings: List[Binding] = Nil): Template

var mode : String

def ne (arg0: AnyRef): Boolean

def notify (): Unit

def notifyAll (): Unit