DefaultRenderContext 1.9.0 - org.fusesource.scalate.DefaultRenderContext

Instance Constructors

new DefaultRenderContext(_requestUri: String, engine: TemplateEngine, out: PrintWriter = new PrintWriter(new StringWriter()))

Type Members

case class Unescaped(text: String) extends Product with Serializable

Used to represent some text which does not need escaping
Used to represent some text which does not need escaping

Definition Classes
RenderContext

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from DefaultRenderContext to any2stringadd[DefaultRenderContext] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (DefaultRenderContext, B)

Implicit information
This member is added by an implicit conversion from DefaultRenderContext to ArrowAssoc[DefaultRenderContext] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
def <<(v: Any): Unit

Renders the provided value and inserts it into the final rendered document without sanitizing the value.
Renders the provided value and inserts it into the final rendered document without sanitizing the value.

Definition Classes
DefaultRenderContext → RenderContext
def <<<(v: Any): Unit

Renders the provided value, sanitizes any XML special characters and inserts it into the final rendered document.
Renders the provided value, sanitizes any XML special characters and inserts it into the final rendered document.

Definition Classes
DefaultRenderContext → RenderContext
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def attribute[T](name: String): T

Returns the attribute of the given type or a org.fusesource.scalate.NoValueSetException exception is thrown
Returns the attribute of the given type or a org.fusesource.scalate.NoValueSetException exception is thrown

Definition Classes
RenderContext
def attributeKeys: List[String]

Sorted list of attribute keys
Sorted list of attribute keys

Definition Classes
RenderContext
def attributeOrElse[T](name: String, defaultValue: ⇒ T): T

Returns the attribute of the given name and type or the default value if it is not available
Returns the attribute of the given name and type or the default value if it is not available

Definition Classes
RenderContext
val attributes: AttributeMap

Access the attributes available in this context
Access the attributes available in this context

Definition Classes
DefaultRenderContext → RenderContext
def blankString: String

Attributes
protected
Definition Classes
RenderContext
def capture(template: Template): String

Evaluates the template capturing any output written to this page context during the body evaluation
Evaluates the template capturing any output written to this page context during the body evaluation

Definition Classes
DefaultRenderContext → RenderContext
def capture(body: ⇒ Unit): String

Evaluates the body capturing any output written to this page context during the body evaluation
Evaluates the body capturing any output written to this page context during the body evaluation

Definition Classes
DefaultRenderContext → RenderContext
def captureAttribute(name: String)(body: ⇒ Unit): Unit

Captured the body of the function call then sets it to the given attribute value
Captured the body of the function call then sets it to the given attribute value

Definition Classes
RenderContext
def captureAttributeAppend(name: String)(body: ⇒ Unit): Unit

Captured the body of the function call then append it to the given attribute value
Captured the body of the function call then append it to the given attribute value

Definition Classes
RenderContext
def captureNodeSeq(template: Template): NodeSeq

Captures the text of the template rendering and then parses it as markup
Captures the text of the template rendering and then parses it as markup

Definition Classes
RenderContext
def captureNodeSeq(body: ⇒ Unit): NodeSeq

Captures the text of the body and then parses it as markup
Captures the text of the body and then parses it as markup

Definition Classes
RenderContext
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def collection(objects: Iterable[AnyRef], viewName: String = "index", separator: ⇒ Any = blankString): Unit

Renders a collection of model objects with an optional separator
Renders a collection of model objects with an optional separator

Definition Classes
RenderContext
var currentTemplate: String

Definition Classes
RenderContext
def dateFormat: DateFormat

Definition Classes
RenderContext
def dateFormat_=(value: DateFormat): Unit

Definition Classes
RenderContext
val engine: TemplateEngine

Definition Classes
DefaultRenderContext → RenderContext
def ensuring(cond: (DefaultRenderContext) ⇒ Boolean, msg: ⇒ Any): DefaultRenderContext

Implicit information
This member is added by an implicit conversion from DefaultRenderContext to Ensuring[DefaultRenderContext] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (DefaultRenderContext) ⇒ Boolean): DefaultRenderContext

Implicit information
This member is added by an implicit conversion from DefaultRenderContext to Ensuring[DefaultRenderContext] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): DefaultRenderContext

Implicit information
This member is added by an implicit conversion from DefaultRenderContext to Ensuring[DefaultRenderContext] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): DefaultRenderContext

Implicit information
This member is added by an implicit conversion from DefaultRenderContext to Ensuring[DefaultRenderContext] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def escape(v: Any): Unit

Ensures that the string value of the parameter is always markup escaped
Ensures that the string value of the parameter is always markup escaped

Definition Classes
RenderContext
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
RenderContext
def filter(name: String, content: String): String

Definition Classes
RenderContext
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def flush(): Unit
def format(pattern: String, args: AnyRef*): String

Returns the formatted string using the locale of the users request or the default locale if not available
Returns the formatted string using the locale of the users request or the default locale if not available

Definition Classes
RenderContext
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from DefaultRenderContext to StringFormat[DefaultRenderContext] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def include(path: String, layout: Boolean, extraBindings: Iterable[Binding]): Unit

Includes the given template path
Includes the given template path
layout
if true then applying the layout the included template

Definition Classes
RenderContext
def include(path: String, layout: Boolean): Unit

Definition Classes
RenderContext
def include(path: String): Unit

Definition Classes
RenderContext
def inject[T](implicit manifest: ClassTag[T]): T

Creates an instance of the given given type using dependency injection to inject the necessary values into the object
Creates an instance of the given given type using dependency injection to inject the necessary values into the object

Definition Classes
RenderContext
def introspect(aType: Class[_]): Introspector[_]

Definition Classes
RenderContext
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def layout(path: String, attrMap: Map[String, Any] = Map())(body: ⇒ Unit): Unit

Renders the given template with optional attributes passing the body block as the *body* attribute so that it can be layered out using the template.
Renders the given template with optional attributes passing the body block as the *body* attribute so that it can be layered out using the template.

Definition Classes
RenderContext
def load(uri: String): String

Loads the given template or file as a String for inclusion into the current page.
Loads the given template or file as a String for inclusion into the current page.
Useful if you want to include some client side template, particularly with a .jade extension

Definition Classes
RenderContext
def locale: Locale

Definition Classes
RenderContext
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
var noneString: String

Default string used to output None values
Default string used to output None values

Definition Classes
RenderContext
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
var nullString: String

Default string used to output null values
Default string used to output null values

Definition Classes
RenderContext
def numberFormat: NumberFormat

Definition Classes
RenderContext
def numberFormat_=(value: NumberFormat): Unit

Definition Classes
RenderContext
var out: PrintWriter
def percent(number: Number): String

Definition Classes
RenderContext
def percentFormat: NumberFormat

Definition Classes
RenderContext
def percentFormat_=(value: NumberFormat): Unit

Definition Classes
RenderContext
def removeOldAttributes: Boolean

Should we remove attributes from the context after we've rendered a child request?
Should we remove attributes from the context after we've rendered a child request?

Attributes
protected
Definition Classes
RenderContext
def render(path: String, attributeMap: Map[String, Any] = Map()): Unit

Renders the given template with optional attributes
Renders the given template with optional attributes

Definition Classes
RenderContext
def requestFile: Option[File]

Returns the file for the given request resource
Returns the file for the given request resource

Definition Classes
DefaultRenderContext → RenderContext
def requestResource: Option[Resource]

Returns the Resource of the request
Returns the Resource of the request

Definition Classes
DefaultRenderContext → RenderContext
def requestUri: String

Returns the request URI
Returns the request URI

Definition Classes
DefaultRenderContext → RenderContext
def resolveUri(path: String): String

Attributes
protected
Definition Classes
RenderContext
def resource[T]: T

Returns the JAXRS resource bean of the given type or a org.fusesource.scalate.NoValueSetException exception is thrown
Returns the JAXRS resource bean of the given type or a org.fusesource.scalate.NoValueSetException exception is thrown

Definition Classes
RenderContext
def resourceOrElse[T](defaultValue: T): T

Returns the JAXRS resource bean of the given type or the default value if it is not available
Returns the JAXRS resource bean of the given type or the default value if it is not available

Definition Classes
RenderContext
def setAttribute(name: String, value: Option[Any]): Unit

Definition Classes
RenderContext
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
implicit def toStringPair(entry: (Symbol, Any)): (String, Any)

Allows a symbol to be used with arguments to the { @link render } or { @link layout } method such as render("foo.ssp", 'foo -> 123, 'bar -> 456) {...}
Allows a symbol to be used with arguments to the { @link render } or { @link layout } method such as render("foo.ssp", 'foo -> 123, 'bar -> 456) {...}
Definition Classes RenderContext
def unescape(v: Any): Unit Ensures that the string value of the parameter is not markup escaped Ensures that the string value of the parameter is not markup escaped Definition Classes RenderContext
def uri(u: String): String Allows conversion of an absolute URL starting with "/" to be converted using the prefix of a web application Allows conversion of an absolute URL starting with "/" to be converted using the prefix of a web application Definition Classes RenderContext
def uri(file: File): Option[String] Returns a local link to the given file which should be within the [sourceDirectories] Returns a local link to the given file which should be within the [sourceDirectories] Definition Classes RenderContext
def using[T](model: AnyRef)(op: ⇒ T): T Attributes protected Definition Classes RenderContext
def value(any: Any, shouldSanitize: Boolean = escapeMarkup): Any Definition Classes RenderContext
def valueEscaped(any: Any): Any Definition Classes RenderContext
def valueUnescaped(any: Any): Any Definition Classes RenderContext
def view(model: AnyRef, viewName: String = "index"): Unit Renders the view of the given model object, looking for the view in packageName/className.viewName.ext Renders the view of the given model object, looking for the view in packageName/className.viewName.ext Definition Classes RenderContext
var viewPostfixes: List[String] Definition Classes RenderContext
var viewPrefixes: List[String] Definition Classes RenderContext
final def wait(): Unit Definition Classes AnyRef Annotations @throws( ... )
final def wait(arg0: Long, arg1: Int): Unit Definition Classes AnyRef Annotations @throws( ... )
final def wait(arg0: Long): Unit Definition Classes AnyRef Annotations @throws( ... )
def withAttributes[T](attrMap: Map[String, Any])(block: ⇒ T): T Uses the new sets of attributes for the given block, then replace them all (and remove any newly defined attributes) Uses the new sets of attributes for the given block, then replace them all (and remove any newly defined attributes) Definition Classes RenderContext
def withUri[T](uri: String)(block: ⇒ T): T Definition Classes RenderContext
var wrapCssInCData: Boolean Whether we should escape CSS in CDATA sections when using the CSS filter Whether we should escape CSS in CDATA sections when using the CSS filter Definition Classes RenderContext
def →[B](y: B): (DefaultRenderContext, B) Implicit information This member is added by an implicit conversion from DefaultRenderContext to ArrowAssoc[DefaultRenderContext] performed by method ArrowAssoc in scala.Predef. Definition Classes ArrowAssoc



        
        
              Inherited from RenderContext
            

              Inherited from AnyRef
            

              Inherited from Any
            
        
              Inherited by implicit conversion any2stringadd from
                DefaultRenderContext to any2stringadd[DefaultRenderContext]
              
            

              Inherited by implicit conversion StringFormat from
                DefaultRenderContext to StringFormat[DefaultRenderContext]
              
            

              Inherited by implicit conversion Ensuring from
                DefaultRenderContext to Ensuring[DefaultRenderContext]
              
            

              Inherited by implicit conversion ArrowAssoc from
                DefaultRenderContext to ArrowAssoc[DefaultRenderContext]
              
            
        

        
        
              Ungrouped

DefaultRenderContext

Related Docs: object DefaultRenderContext | package scalate

class DefaultRenderContext extends RenderContext

Instance Constructors

new DefaultRenderContext(_requestUri: String, engine: TemplateEngine, out: PrintWriter = new PrintWriter(new StringWriter()))

Type Members

case class Unescaped(text: String) extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (DefaultRenderContext, B)

def <<(v: Any): Unit

def <<<(v: Any): Unit

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def attribute[T](name: String): T

def attributeKeys: List[String]

def attributeOrElse[T](name: String, defaultValue: ⇒ T): T

val attributes: AttributeMap

def blankString: String

def capture(template: Template): String

def capture(body: ⇒ Unit): String

def captureAttribute(name: String)(body: ⇒ Unit): Unit

def captureAttributeAppend(name: String)(body: ⇒ Unit): Unit

def captureNodeSeq(template: Template): NodeSeq

def captureNodeSeq(body: ⇒ Unit): NodeSeq

def clone(): AnyRef

def collection(objects: Iterable[AnyRef], viewName: String = "index", separator: ⇒ Any = blankString): Unit

var currentTemplate: String

def dateFormat: DateFormat

def dateFormat_=(value: DateFormat): Unit

val engine: TemplateEngine

def ensuring(cond: (DefaultRenderContext) ⇒ Boolean, msg: ⇒ Any): DefaultRenderContext

def ensuring(cond: (DefaultRenderContext) ⇒ Boolean): DefaultRenderContext

def ensuring(cond: Boolean, msg: ⇒ Any): DefaultRenderContext

def ensuring(cond: Boolean): DefaultRenderContext

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def escape(v: Any): Unit

var escapeMarkup: Boolean

def filter(name: String, content: String): String

def finalize(): Unit

def flush(): Unit

def format(pattern: String, args: AnyRef*): String

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

def include(path: String, layout: Boolean, extraBindings: Iterable[Binding]): Unit

def include(path: String, layout: Boolean): Unit

def include(path: String): Unit

def inject[T](implicit manifest: ClassTag[T]): T

def introspect(aType: Class[_]): Introspector[_]

final def isInstanceOf[T0]: Boolean

def layout(path: String, attrMap: Map[String, Any] = Map())(body: ⇒ Unit): Unit

def load(uri: String): String

def locale: Locale

final def ne(arg0: AnyRef): Boolean

var noneString: String

final def notify(): Unit

final def notifyAll(): Unit

var nullString: String

def numberFormat: NumberFormat

def numberFormat_=(value: NumberFormat): Unit

var out: PrintWriter

def percent(number: Number): String

def percentFormat: NumberFormat

def percentFormat_=(value: NumberFormat): Unit

def removeOldAttributes: Boolean

def render(path: String, attributeMap: Map[String, Any] = Map()): Unit

def requestFile: Option[File]

def requestResource: Option[Resource]

def requestUri: String

def resolveUri(path: String): String

def resource[T]: T

def resourceOrElse[T](defaultValue: T): T

def setAttribute(name: String, value: Option[Any]): Unit

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

def toString(): String

implicit def toStringPair(entry: (Symbol, Any)): (String, Any)