org.fusesource.scalate.servlet.ServletTemplateEngine

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

ServletTemplateEngine
TemplateEngine
AnyRef
Any

Visibility

Public
All

Instance Constructors

new ServletTemplateEngine (config: Config)

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

Definition Classes
TemplateEngine
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

Definition Classes
TemplateEngine
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
By default lets bind the context so we get to reuse its methods in a template

Definition Classes
TemplateEngine
def boot : Unit

Definition Classes
TemplateEngine
var bootClassName : String

Definition Classes
TemplateEngine
var bootInjections : List[AnyRef]

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

Attributes
protected
Definition Classes
TemplateEngine
def bytecodeDirectory : File

Definition Classes
TemplateEngine
def cacheHits : Int

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

Definition Classes
TemplateEngine
def cacheMisses : Int

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

Definition Classes
TemplateEngine
def canLoad (uri: String, extraBindings: Traversable[Binding]): Boolean

Returns true if the URI can be loaded as a template
Returns true if the URI can be loaded as a template

Definition Classes
TemplateEngine
def canLoad (uri: String): Boolean

Returns true if the URI can be loaded as a template
Returns true if the URI can be loaded as a template

Definition Classes
TemplateEngine
def canLoad (source: TemplateSource, extraBindings: Traversable[Binding] = Nil): Boolean

Returns true if the URI can be loaded as a template
Returns true if the URI can be loaded as a template

Definition Classes
TemplateEngine
def classFileName (uri: String): File

Attributes
protected
Definition Classes
TemplateEngine
var classLoader : ClassLoader

Definition Classes
TemplateEngine
var classpath : String

Definition Classes
TemplateEngine
def clone (): AnyRef

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

The supported template engines and their default extensions
The supported template engines and their default extensions

Definition Classes
TemplateEngine
var combinedClassPath : Boolean

Whether a custom classpath should be combined with the deduced classpath
Whether a custom classpath should be combined with the deduced classpath

Definition Classes
TemplateEngine
def compile (source: TemplateSource, extraBindings: Traversable[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

Definition Classes
TemplateEngine
def compileMoustache (text: String, extraBindings: Traversable[Binding] = Nil): Template

Compiles the given Moustache template text and returns the template
Compiles the given Moustache template text and returns the template

Definition Classes
TemplateEngine
def compileScaml (text: String, extraBindings: Traversable[Binding] = Nil): Template

Compiles the given SSP template text and returns the template
Compiles the given SSP template text and returns the template

Definition Classes
TemplateEngine
def compileSsp (text: String, extraBindings: Traversable[Binding] = Nil): Template

Compiles the given SSP template text and returns the template
Compiles the given SSP template text and returns the template

Definition Classes
TemplateEngine
def compileText (extension: String, text: String, extraBindings: Traversable[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
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

Definition Classes
TemplateEngine
lazy val compiler : Compiler

Definition Classes
TemplateEngine
val config : Config
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
Definition Classes
TemplateEngine
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
Definition Classes
TemplateEngine
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

Definition Classes
TemplateEngine
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
Definition Classes
TemplateEngine
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"))
Maps file extensions to possible template extensions for custom mappins such as for Map("js" -> Set("coffee"), "css" => Set("sass", "scss"))

Definition Classes
TemplateEngine
def extensions : Set[String]

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

Definition Classes
TemplateEngine
def filter (name: String): Option[Filter]

Definition Classes
TemplateEngine
var filters : Map[String, Filter]

Definition Classes
TemplateEngine
def finalize (): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
val finderCache : ConcurrentHashMap[String, String]

Definition Classes
TemplateEngine
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.

Definition Classes
TemplateEngine
def generateScala (uri: String, extraBindings: Traversable[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.

Definition Classes
TemplateEngine
def generateScala (source: TemplateSource, extraBindings: Traversable[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.

Definition Classes
TemplateEngine
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
Definition Classes
TemplateEngine
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
Definition Classes
TemplateEngine
def getClass (): java.lang.Class[_]

Attributes
final
Definition Classes
AnyRef → Any
def hashCode (): Int

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

Sets the import statements used in each generated template class
Sets the import statements used in each generated template class

Definition Classes
TemplateEngine
def invalidateCachedTemplates (): Boolean

Invalidates all cached Templates.
Invalidates all cached Templates.

Definition Classes
TemplateEngine
def isDevelopmentMode : Boolean

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

Definition Classes
TemplateEngine
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
Renders the given template source using the current layoutStrategy

Definition Classes
TemplateEngine
def layout (source: TemplateSource, context: RenderContext, extraBindings: Traversable[Binding]): Unit

Renders the given template source using the current layoutStrategy
Renders the given template source using the current layoutStrategy

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

Renders the given template source using the current layoutStrategy
Renders the given template source using the current layoutStrategy

Definition Classes
TemplateEngine
def layout (source: TemplateSource): String

Renders the given template source using the current layoutStrategy
Renders the given template source using the current layoutStrategy

Definition Classes
TemplateEngine
def layout (uri: String, template: Template): String

Definition Classes
TemplateEngine
def layout (uri: String, context: RenderContext): Unit

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

Renders the given template returning the output
Renders the given template returning the output

Definition Classes
TemplateEngine
def layout (uri: String, template: Template, out: PrintWriter, attributes: Map[String, Any]): Unit

Attributes
protected
Definition Classes
TemplateEngine
def layout (uri: String, out: PrintWriter, attributes: Map[String, Any]): Unit

Definition Classes
TemplateEngine
def layout (uri: String, attributes: Map[String, Any] = Map(), extraBindings: Traversable[Binding] = Nil): String

Renders the given template URI returning the output
Renders the given template URI returning the output

Definition Classes
TemplateEngine
def layout (template: Template, context: RenderContext): Unit

Renders the given template using the current layoutStrategy
Renders the given template using the current layoutStrategy

Definition Classes
TemplateEngine
def layout (uri: String, context: RenderContext, extraBindings: Traversable[Binding]): Unit

Renders the given template URI using the current layoutStrategy
Renders the given template URI using the current layoutStrategy

Definition Classes
TemplateEngine
def layoutAsNodes (uri: String, template: Template): NodeSeq

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

Renders the given template returning the output
Renders the given template returning the output

Definition Classes
TemplateEngine
def layoutAsNodes (uri: String, attributes: Map[String, Any] = Map(), extraBindings: Traversable[Binding] = Nil): NodeSeq

Renders the given template URI returning the output
Renders the given template URI returning the output

Definition Classes
TemplateEngine
var layoutStrategy : LayoutStrategy

Definition Classes
TemplateEngine
def libraryDirectory : File

Definition Classes
TemplateEngine
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.

Definition Classes
TemplateEngine
def load (uri: String, extraBindings: Traversable[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.

Definition Classes
TemplateEngine
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.

Definition Classes
TemplateEngine
def load (file: File, extraBindings: Traversable[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.

Definition Classes
TemplateEngine
def load (source: TemplateSource, extraBindings: Traversable[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.

Definition Classes
TemplateEngine
var mode : String

Definition Classes
TemplateEngine
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

Definition Classes
TemplateEngine
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
Definition Classes
TemplateEngine
var pipelines : Map[String, List[Filter]]

Definition Classes
TemplateEngine
var resourceLoader : ResourceLoader

Loads resources such as the templates based on URIs
Loads resources such as the templates based on URIs

Definition Classes
TemplateEngine
def source (uri: String, templateType: String): TemplateSource

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

Definition Classes
TemplateEngine
def source (uri: String): TemplateSource

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

Definition Classes
TemplateEngine
var sourceDirectories : Traversable[File]

Definition Classes
TemplateEngine
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
Definition Classes
TemplateEngine
def sourceDirectory : File

Definition Classes
TemplateEngine
def sourceFileName (uri: String): File

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

Attributes
protected
Definition Classes
TemplateEngine
val sourceMapLog : Log

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

Attributes
protected
Definition Classes
TemplateEngine
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.
A list of directories which are searched to load requested templates.

Definition Classes
TemplateEngine
def templateExtensionsFor (extension: String): Set[String]

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

Definition Classes
TemplateEngine
def tmpDirectory : File

Definition Classes
TemplateEngine
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
Definition Classes
TemplateEngine
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
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

Definition Classes
TemplateEngine
def workingDirectory_= (value: File): Unit

Definition Classes
TemplateEngine

ServletTemplateEngine

class ServletTemplateEngine extends TemplateEngine

Instance Constructors

new ServletTemplateEngine (config: Config)

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: Traversable[Binding]): Boolean

def canLoad (uri: String): Boolean

def canLoad (source: TemplateSource, extraBindings: Traversable[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: Traversable[Binding] = Nil): Template

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

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

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

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

lazy val compiler : Compiler

val config : Config

def createCompiler : Compiler

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]

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

def extensions : Set[String]

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

var filters : Map[String, Filter]

def finalize (): Unit

val finderCache : ConcurrentHashMap[String, String]

def generateScala (uri: String): Code

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

def generateScala (source: TemplateSource, extraBindings: Traversable[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: Traversable[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, template: Template, out: PrintWriter, attributes: Map[String, Any]): Unit

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

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

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

def layout (uri: String, context: RenderContext, extraBindings: Traversable[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: Traversable[Binding] = Nil): NodeSeq

var layoutStrategy : LayoutStrategy

def libraryDirectory : File

def load (uri: String): Template

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

def load (file: File): Template