org.fusesource.scalate.servlet

ServletRenderContext

class ServletRenderContext extends DefaultRenderContext

A template context for use in servlets

go to: companion
    version
  1. $Revision : 1.1 $

Inherited
  1. Hide All
  2. Show all
  1. DefaultRenderContext
  2. Logging
  3. RenderContext
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All

Instance constructors

  1. new ServletRenderContext(engine: TemplateEngine, request: HttpServletRequest, response: HttpServletResponse, servletContext: ServletContext)

  2. new ServletRenderContext(engine: TemplateEngine, out: PrintWriter, request: HttpServletRequest, response: HttpServletResponse, servletContext: ServletContext)

Type Members

  1. class Unescaped(text: String) extends Product

    Used to represent some text which does not need escaping

Value Members

  1. def !=(arg0: AnyRef): Boolean

    attributes: final
    definition classes: AnyRef
  2. def !=(arg0: Any): Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ##(): Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf[T0](): T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf[T0](): Boolean

    attributes: final
    definition classes: AnyRef
  6. 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: DefaultRenderContextRenderContext
  7. 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: DefaultRenderContextRenderContext
  8. def ==(arg0: AnyRef): Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  9. def ==(arg0: Any): Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  10. def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  11. def attribute[T](name: String): T

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

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

    definition classes: RenderContext
  12. def attributeKeys: List[String]

    Sorted list of attribute keys

    Sorted list of attribute keys

    definition classes: RenderContext
  13. 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
  14. val attributes: AttributeMap[String, Any]

    Access the attributes available in this context

    Access the attributes available in this context

  15. def blankString: String

    attributes: protected
    definition classes: RenderContext
  16. 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: DefaultRenderContextRenderContext
  17. 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: DefaultRenderContextRenderContext
  18. def captureAttribute(name: String)(body: ⇒ Unit): Unit

    Sets the given attribute name to be the captured body of the template

    Sets the given attribute name to be the captured body of the template

    definition classes: RenderContext
  19. 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
  20. 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
  21. def clone(): AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  22. def collection(objects: Traversable[AnyRef], viewName: String = "index", separator: ⇒ Any = RenderContext.this.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
  23. def contextPath: String

    Returns the forwarded context path or the current context path if its not forwarded

    Returns the forwarded context path or the current context path if its not forwarded

  24. var currentTemplate: String

    definition classes: RenderContext
  25. def currentUriMinus(newQueryArgs: String): String

    Returns the current URI with query arguments (separated with &) removed

    Returns the current URI with query arguments (separated with &) removed

  26. def currentUriPlus(newQueryArgs: String): String

    Returns the current URI with new query arguments (separated with &)

    Returns the current URI with new query arguments (separated with &)

  27. def dateFormat: DateFormat

    definition classes: RenderContext
  28. def dateFormat_=(value: DateFormat): Unit

    definition classes: RenderContext
  29. def debug(e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  30. def debug(message: ⇒ String, e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  31. def debug(message: ⇒ String): Unit

    attributes: protected
    definition classes: Logging
  32. def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  33. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  34. def error(e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  35. def error(message: ⇒ String, e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  36. def error(message: ⇒ String): Unit

    attributes: protected
    definition classes: Logging
  37. 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
  38. var escapeMarkup: Boolean

    Whether or not markup sensitive characters for HTML/XML elements like &amp; &gt; &lt; are escaped or not

    Whether or not markup sensitive characters for HTML/XML elements like &amp; &gt; &lt; are escaped or not

    definition classes: RenderContext
  39. def filter(name: String, content: String): String

    definition classes: RenderContext
  40. def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  41. def flush: Unit

    definition classes: DefaultRenderContext
  42. 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
  43. def forward(page: String, escape: Boolean = false): Unit

    Forwards this request to the given page

    Forwards this request to the given page

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

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  45. def hashCode(): Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  46. def include(path: String, layout: Boolean, extraBindings: List[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
  47. def include(path: String, layout: Boolean): Unit

    definition classes: RenderContext
  48. def include(path: String): Unit

    definition classes: RenderContext
  49. def info(e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  50. def info(message: ⇒ String, e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  51. def info(message: ⇒ String): Unit

    attributes: protected
    definition classes: Logging
  52. def inject[T](implicit manifest: Manifest[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
  53. def introspect(aType: java.lang.Class[_]): org.fusesource.scalate.introspector.Introspector[_]

    definition classes: RenderContext
  54. def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  55. def layout(path: String, attrMap: Map[String, Any] = scala.this.Predef.Map.apply[String, Nothing]())(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
  56. def locale: Locale

    definition classes: ServletRenderContextRenderContext
  57. def log: Log

    attributes: protected
    definition classes: Logging
  58. def ne(arg0: AnyRef): Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  59. var noneString: String

    Default string used to output None values

    Default string used to output None values

    definition classes: RenderContext
  60. def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  61. def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  62. var nullString: String

    Default string used to output null values

    Default string used to output null values

    definition classes: RenderContext
  63. def numberFormat: NumberFormat

    definition classes: RenderContext
  64. def numberFormat_=(value: NumberFormat): Unit

    definition classes: RenderContext
  65. def parameter(name: String): String

    Returns the first parameter

    Returns the first parameter

  66. def parameterValues(name: String): Array[String]

    Returns all of the parameter values

    Returns all of the parameter values

  67. def percent(number: Number): String

    definition classes: RenderContext
  68. def percentFormat: NumberFormat

    definition classes: RenderContext
  69. def percentFormat_=(value: NumberFormat): Unit

    definition classes: RenderContext
  70. def queryString: String

    Returns the forwarded query string or the current query string if its not forwarded

    Returns the forwarded query string or the current query string if its not forwarded

  71. 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
  72. def render(path: String, attributeMap: Map[String, Any] = scala.this.Predef.Map.apply[String, Nothing]()): Unit

    Renders the given template with optional attributes

    Renders the given template with optional attributes

    definition classes: RenderContext
  73. val request: HttpServletRequest

  74. def requestDispatcher(page: String): RequestDispatcher

    attributes: protected
  75. def requestFile: Option[File]

    Returns the file for the given request resource

    Returns the file for the given request resource

    definition classes: DefaultRenderContextRenderContext
  76. def requestResource: Option[Resource]

    Returns the Resource of the request

    Returns the Resource of the request

    definition classes: DefaultRenderContextRenderContext
  77. def requestUri: String

    Returns the forwarded request uri or the current request URI if its not forwarded

    Returns the forwarded request uri or the current request URI if its not forwarded

  78. def resolveUri(path: String): String

    attributes: protected
    definition classes: RenderContext
  79. def resource[T]: T

    Returns the JAXRS resource bean of the given type or a NoValueSetExceptionexception is thrown

    Returns the JAXRS resource bean of the given type or a NoValueSetExceptionexception is thrown

    definition classes: RenderContext
  80. 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
  81. val response: HttpServletResponse

  82. def servlet(page: String, escape: Boolean = false): Unit

    Includes the given servlet page

    Includes the given servlet page

  83. def servletConfig: Config

    Named servletConfig for historical reasons; actually returns a Config, which presents a unified view of either a ServletConfig or a FilterConfig.

    Named servletConfig for historical reasons; actually returns a Config, which presents a unified view of either a ServletConfig or a FilterConfig.

    returns

    a Config, if the servlet engine is a ServletTemplateEngine

  84. val servletContext: ServletContext

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

    definition classes: RenderContext
  86. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef
  87. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  88. 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 asrender("foo.

    Allows a symbol to be used with arguments to the { @link render } or { @link layout } method such asrender("foo.ssp", 'foo -> 123, 'bar -> 456) {...}

    attributes: implicit
    definition classes: RenderContext
  89. def trace(e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  90. def trace(message: ⇒ String, e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  91. def trace(message: ⇒ String): Unit

    attributes: protected
    definition classes: Logging
  92. 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
  93. def uri(uri: String): String

    Creates a URI which if the uri starts with / then the link is prefixed with the web applications context

    Creates a URI which if the uri starts with / then the link is prefixed with the web applications context

    definition classes: ServletRenderContextRenderContext
  94. 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
  95. def using[T](model: AnyRef)(op: ⇒ T): T

    attributes: protected
    definition classes: RenderContext
  96. def value(any: Any, shouldSanitize: Boolean = RenderContext.this.escapeMarkup): Any

    definition classes: RenderContext
  97. def valueEscaped(any: Any): Any

    definition classes: RenderContext
  98. def valueUnescaped(any: Any): Any

    definition classes: RenderContext
  99. def view(model: AnyRef, viewName: String = "index"): Unit

    Renders the view of the given model object, looking for the view in packageName/className.

    Renders the view of the given model object, looking for the view in packageName/className.viewName.ext

    definition classes: RenderContext
  100. var viewPostfixes: List[String]

    definition classes: RenderContext
  101. var viewPrefixes: List[String]

    definition classes: RenderContext
  102. def wait(): Unit

    attributes: final
    definition classes: AnyRef
  103. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef
  104. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef
  105. def warn(e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  106. def warn(message: ⇒ String, e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  107. def warn(message: ⇒ String): Unit

    attributes: protected
    definition classes: Logging
  108. 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
  109. def withUri[T](uri: String)(block: ⇒ T): T

    definition classes: RenderContext
  110. def wrappedRequest: WrappedRequest

    attributes: protected
  111. def wrappedResponse: WrappedResponse

    attributes: protected