org.scalatra.scalate

ScalatraRenderContext

class ScalatraRenderContext extends ServletRenderContext

A render context integrated with Scalatra. Exposes a few extra standard bindings to the template.

linear super types: ServletRenderContext, DefaultRenderContext, RenderContext, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. ScalatraRenderContext
  2. ServletRenderContext
  3. DefaultRenderContext
  4. RenderContext
  5. AnyRef
  6. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new ScalatraRenderContext (scalate: ScalateSupport)

  2. new ScalatraRenderContext (scalate: ScalateSupport, request: HttpServletRequest, response: HttpServletResponse)

  3. new ScalatraRenderContext (kernel: ScalatraKernel, engine: TemplateEngine, out: PrintWriter, request: HttpServletRequest, response: HttpServletResponse)

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

    definition classes: DefaultRenderContext → RenderContext
  7. def <<< (v: Any) : Unit

    definition classes: DefaultRenderContext → RenderContext
  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

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

    definition classes: RenderContext
  13. def attributeOrElse [T] (name: String, defaultValue: ⇒ T) : T

    definition classes: RenderContext
  14. val attributes : AttributeMap

    definition classes: ServletRenderContext → DefaultRenderContext → RenderContext
  15. def blankString : String

    attributes: protected
    definition classes: RenderContext
  16. def capture (template: Template) : String

    definition classes: DefaultRenderContext → RenderContext
  17. def capture (body: ⇒ Unit) : String

    definition classes: DefaultRenderContext → RenderContext
  18. def captureAttribute (name: String)(body: ⇒ Unit) : Unit

    definition classes: RenderContext
  19. def captureAttributeAppend (name: String)(body: ⇒ Unit) : Unit

    definition classes: RenderContext
  20. def captureNodeSeq (template: Template) : NodeSeq

    definition classes: RenderContext
  21. def captureNodeSeq (body: ⇒ Unit) : NodeSeq

    definition classes: RenderContext
  22. 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[lang]
    definition classes: AnyRef
  23. def collection (objects: Traversable[AnyRef], viewName: String, separator: ⇒ Any) : Unit

    definition classes: RenderContext
  24. def contextPath : String

    definition classes: ServletRenderContext
  25. var currentTemplate : String

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

    definition classes: ServletRenderContext
  27. def currentUriPlus (newQueryArgs: String) : String

    definition classes: ServletRenderContext
  28. def dateFormat : DateFormat

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

    definition classes: RenderContext
  30. 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
  31. 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
  32. def escape (v: Any) : Unit

    definition classes: RenderContext
  33. var escapeMarkup : Boolean

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

    definition classes: RenderContext
  35. 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[lang]
    definition classes: AnyRef
  36. def flash : Map[String, Any]

  37. def flush : Unit

    definition classes: DefaultRenderContext
  38. def format (pattern: String, args: AnyRef*) : String

    definition classes: RenderContext
  39. def forward (page: String, escape: Boolean) : Unit

    definition classes: ServletRenderContext
  40. 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
  41. 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
  42. def include (path: String, layout: Boolean, extraBindings: Traversable[Binding]) : Unit

    definition classes: RenderContext
  43. def include (path: String, layout: Boolean) : Unit

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

    definition classes: RenderContext
  45. def inject [T] (implicit manifest: Manifest[T]) : T

    definition classes: RenderContext
  46. def introspect (aType: Class[_]) : org.fusesource.scalate.introspector.Introspector[_]

    definition classes: RenderContext
  47. 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
  48. val kernel : ScalatraKernel

    attributes: protected
  49. def layout (path: String, attrMap: Map[String, Any])(body: ⇒ Unit) : Unit

    definition classes: RenderContext
  50. def load (uri: String) : String

    definition classes: RenderContext
  51. def locale : Locale

    definition classes: ServletRenderContext → RenderContext
  52. def multiParams : MultiParams

  53. 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
  54. var noneString : String

    definition classes: RenderContext
  55. 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
  56. 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
  57. var nullString : String

    definition classes: RenderContext
  58. def numberFormat : NumberFormat

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

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

    definition classes: ServletRenderContext
  61. def parameterValues (name: String) : Array[String]

    definition classes: ServletRenderContext
  62. def params : Map[String, String]

  63. def percent (number: Number) : String

    definition classes: RenderContext
  64. def percentFormat : NumberFormat

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

    definition classes: RenderContext
  66. def queryString : String

    definition classes: ServletRenderContext
  67. def removeOldAttributes : Boolean

    attributes: protected
    definition classes: RenderContext
  68. def render (path: String, attributeMap: Map[String, Any]) : Unit

    definition classes: RenderContext
  69. def requestDispatcher (page: String) : RequestDispatcher

    attributes: protected
    definition classes: ServletRenderContext
  70. def requestFile : Option[File]

    definition classes: DefaultRenderContext → RenderContext
  71. def requestResource : Option[Resource]

    definition classes: DefaultRenderContext → RenderContext
  72. def requestUri : String

    definition classes: ServletRenderContext → DefaultRenderContext → RenderContext
  73. def resolveUri (path: String) : String

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

    definition classes: RenderContext
  75. def resourceOrElse [T] (defaultValue: T) : T

    definition classes: RenderContext
  76. def servlet (page: String, escape: Boolean) : Unit

    definition classes: ServletRenderContext
  77. def servletConfig : Config

    definition classes: ServletRenderContext
  78. val servletContext : ServletContext

    definition classes: ServletRenderContext
  79. def session : Session

  80. def sessionOption : Option[Session]

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

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

    attributes: final
    definition classes: AnyRef
  83. 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
  84. implicit def toStringPair (entry: (Symbol, Any)) : (String, Any)

    attributes: implicit
    definition classes: RenderContext
  85. def unescape (v: Any) : Unit

    definition classes: RenderContext
  86. def uri (uri: String) : String

    definition classes: ServletRenderContext → RenderContext
  87. def uri (file: File) : Option[String]

    definition classes: RenderContext
  88. def using [T] (model: AnyRef)(op: ⇒ T) : T

    attributes: protected
    definition classes: RenderContext
  89. def value (any: Any, shouldSanitize: Boolean) : Any

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

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

    definition classes: RenderContext
  92. def view (model: AnyRef, viewName: String) : Unit

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

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

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

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

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

    attributes: final
    definition classes: AnyRef
  98. def withAttributes [T] (attrMap: Map[String, Any])(block: ⇒ T) : T

    definition classes: RenderContext
  99. def withUri [T] (uri: String)(block: ⇒ T) : T

    definition classes: RenderContext
  100. var wrapCssInCData : Boolean

    definition classes: RenderContext
  101. def wrappedRequest : WrappedRequest

    attributes: protected
    definition classes: ServletRenderContext
  102. def wrappedResponse : WrappedResponse

    attributes: protected
    definition classes: ServletRenderContext

Inherited from ServletRenderContext

Inherited from DefaultRenderContext

Inherited from RenderContext

Inherited from AnyRef

Inherited from Any