Lift Framework 3.1.0 - net.liftweb.http.S

final def !=(arg0: Any): Boolean

Definition Classes: AnyRef → Any

final def ##(): Int

Definition Classes: AnyRef → Any

final def ==(arg0: Any): Boolean

Definition Classes: AnyRef → Any

def ?(str: String, params: Any*): String

Attempt to localize and then format the given string.

Attempt to localize and then format the given string. This uses the String.format method to format the localized string. We first try your own bundle resources, if that fails, we try Lift's core bundle.

str: the string to localize
params: the var-arg parameters applied for string formatting
returns: the localized and formatted version of the string

Definition Classes: S
See also: # resourceBundles
String.format

def ?(str: String, locale: Locale): String

Get a localized string or return the original string.

Get a localized string or return the original string. We first try your own bundle resources, if that fails, we try Lift's core bundle.

str: the string to localize
locale: specific locale that should be used to localize this string
returns: the localized version of the string

Definition Classes: S
See also: # resourceBundles

def ?(str: String): String

Get a localized string or return the original string.

Get a localized string or return the original string. We first try your own bundle resources, if that fails, we try Lift's core bundle.

str: the string to localize
returns: the localized version of the string

Definition Classes: S
See also: # resourceBundles

def addAnalyzer(f: (Box[Req], Long, List[(String, Long)]) ⇒ Any): Unit

Add a query analyzer (passed queries for analysis or logging).

Add a query analyzer (passed queries for analysis or logging). The analyzer methods are executed with the request, total time to process the request, and the List of query log entries once the current request completes.

Definition Classes: S
See also: # queryLog
# logQuery

def addAround(lw: LoanWrapper): Unit

You can wrap the handling of an HTTP request with your own wrapper.

You can wrap the handling of an HTTP request with your own wrapper. The wrapper can execute code before and after the request is processed (but still have S scope). This allows for query analysis, etc. Wrappers are chained, much like servlet filters, so you can layer processing on the request. As an example, let's look at a wrapper that opens a resource and makes it available via a RequestVar, then closes the resource when finished:

import net.liftweb.http.{ ResourceVar,S }
import net.liftweb.util.LoanWrapper

// Where "ResourceType" is defined by you
object myResource extends ResourceVar[ResourceType](...)

class Boot  {
  def boot  {
    ...
    S.addAround(
      new LoanWrapper  {
        def apply[T](f: => T) : T =  {
          myResource(... code to open and return a resource instance ...)
          f() // This call propagates the request further down the "chain" for template processing, etc.
          myResource.is.close() // Release the resource
}
}
    )
    ...
}
}

This method is *NOT* intended to change the generated HTTP request or to respond to requests early. LoanWrappers are there to set up and take down state *ONLY*. The LoanWrapper may be called outside the scope of an HTTP request (e.g., as part of an Actor invocation).

Definition Classes: S
See also: LoanWrapper
# addAround ( LoanWrapper )

def addAround(lw: List[LoanWrapper]): Unit

You can wrap the handling of an HTTP request with your own wrapper.

You can wrap the handling of an HTTP request with your own wrapper. The wrapper can execute code before and after the request is processed (but still have S scope). This allows for query analysis, etc. See S.addAround(LoanWrapper) for an example. This version of the method takes a list of LoanWrappers that are applied in order. This method is *NOT* intended to change the generated HTTP request or to respond to requests early. LoanWrappers are there to set up and take down state *ONLY*. The LoanWrapper may be called outside the scope of an HTTP request (e.g., as part of an Actor invocation).

Definition Classes: S
See also: LoanWrapper
# addAround ( LoanWrapper )

def addCleanupFunc(f: () ⇒ Unit): Unit

Adds a cleanup function that will be executed at the end of the request pocessing.

Adds a cleanup function that will be executed at the end of the request pocessing. Exceptions thrown from these functions will be swallowed, so make sure to handle any expected exceptions within your function.

f: The function to execute at the end of the request.

Definition Classes: S

def addComet(cometActor: LiftCometActor): Unit

Add a comet to the list of comets that should be registered to receive updates on the page currently being rendered or on the page that invoked the currently running callback.

Definition Classes: S

def addCookie(cookie: HTTPCookie): Unit

Adds a Cookie to the List[Cookies] that will be sent with the Response.

If you wish to delete a Cookie as part of the Response, use the deleteCookie method.

An example of adding and removing a Cookie is:

import net.liftweb.http.provider.HTTPCookie

class MySnippet  {
  final val cookieName = "Fred"

  def cookieDemo (xhtml : NodeSeq) : NodeSeq =  {
    var cookieVal = S.findCookie(cookieName).map(_.getvalue) openOr ""

    def setCookie()  {
      val cookie = HTTPCookie(cookieName, cookieVal).setMaxAge(3600) // 3600 seconds, or one hour
      S.addCookie(cookie)
}

    bind("cookie", xhtml,
         "value" -> SHtml.text(cookieVal, cookieVal = _),
         "add" -> SHtml.submit("Add", setCookie)
         "remove" -> SHtml.link(S.uri, () => S.deleteCookie(cookieName), "Delete Cookie")
    )
}
}

Definition Classes: S
See also: # responseCookies
# deleteCookie ( String )
# deleteCookie ( Cookie )
net.liftweb.http.provider.HTTPCookie

def addFunctionMap(name: String, value: AFuncHolder): Unit

Associates a name with a function impersonated by AFuncHolder.

Associates a name with a function impersonated by AFuncHolder. These are basically functions that are executed when a request contains the 'name' request parameter.

Definition Classes: S

def addHighLevelSessionDispatcher(name: String, disp: DispatchPF): Box[HashMap[String, DispatchPF]]

Adds a dispatch function for the current session, as opposed to a global dispatch through LiftRules.dispatch.

Adds a dispatch function for the current session, as opposed to a global dispatch through LiftRules.dispatch. An example would be if we wanted a user to be able to download a document only when logged in. First, we define a dispatch function to handle the download, specific to a given user:

def getDocument(userId : Long)() : Box[LiftResponse] =  { ... }

Then, in the login/logout handling snippets, we could install and remove the custom dispatch as appropriate:

  def login(xhtml : NodeSeq) : NodeSeq =  {
    def doAuth ()  {
      ...
      if (user.loggedIn_?)  {
        S.addHighLevelSessionDispatcher("docDownload",  {
          case Req(List("download", "docs"), _, _) => getDocument(user.id)
} )
}
}

  def logout(xhtml : NodeSeq) : NodeSeq =  {
    def doLogout ()  {
      ...
      S.removeHighLevelSessionDispatcher("docDownload")
      // or, if more than one dispatch has been installed, this is simpler
      S.clearHighLevelSessionDispatcher
}
}

It's important to note that per-session dispatch takes precedence over LiftRules.dispatch, so you can override things set there.

name: A name for the dispatch. This can be used to remove it later by name.
disp: The dispatch partial function

Definition Classes: S
See also: # clearHighLevelSessionDispatcher
# removeHighLevelSessionDispatcher
LiftRules.dispatch
LiftRules.DispatchPF

def addSessionRewriter(name: String, rw: RewritePF): Box[HashMap[String, RewritePF]]

Adds a per-session rewrite function.

Adds a per-session rewrite function. This can be used if you only want a particular rewrite to be valid within a given session. Per-session rewrites take priority over rewrites set in LiftRules.rewrite, so you can use this mechanism to override global functionality. For example, you could set up a global rule to make requests for the "account profile" page go back to the home page by default:

package bootstrap.liftweb
... imports ...
class Boot  {
  def boot  {
    LiftRules.rewrite.append  {
      case RewriteRequest(ParsePath(List("profile")), _, _, _) =>
        RewriteResponse(List("index"))
}
}
}

Then, in your login snippet, you could set up a per-session rewrite to the correct template:

def loginSnippet (xhtml : NodeSeq) : NodeSeq =  {
  ...
  def doLogin ()  {
    ...
    S.addSessionRewriter("profile",  {
      case RewriteRequest(ParsePath(List("profile")), _, _, _) =>
        RewriteResponse(List("viewProfile"), Map("user" -> user.id))
}
    ...
}
  ...
}

And in your logout snippet you can remove the rewrite:

  def doLogout ()  {
    S.removeSessionRewriter("profile")
    // or
    S.clearSessionRewriter
}

name: A name for the rewrite function so that it can be replaced or deleted later.
rw: The rewrite partial function

Definition Classes: S
See also: # clearSessionRewriter
# removeSessionRewriter
# sessionRewriter
LiftRules.rewrite

def addSnippetForClass(cls: String, inst: DispatchSnippet): Unit

Register a stateful snippet for a given class name.

Register a stateful snippet for a given class name. Only registers if the name is not already set.

Definition Classes: S

def appendGlobalJs(js: JsCmd*): Unit

Add javascript to the page rendering that will execute in the global scope.

Add javascript to the page rendering that will execute in the global scope. Usually you should use appendJs, so that the javascript runs after the entire dom is available. If you need to declare a global var or you want javascript to execute immediately with no guarantee that the entire dom is available, you may use appendGlobalJs.

Definition Classes: S

def appendJs(js: Seq[JsCmd]): Unit

Sometimes it's helpful to accumulate JavaScript as part of servicing a request.

Sometimes it's helpful to accumulate JavaScript as part of servicing a request. For example, you may want to accumulate the JavaScript as part of an Ajax response or a Comet Rendering or as part of a regular HTML rendering. Call S.appendJs(jsCmd). The accumulated Javascript will be emitted as part of the response, wrapped in an OnLoad to ensure that it executes after the entire dom is available. If for some reason you need to run javascript at the top-level scope, use appendGlobalJs.

Definition Classes: S

def appendJs(js: JsCmd): Unit

Sometimes it's helpful to accumulate JavaScript as part of servicing a request.

Sometimes it's helpful to accumulate JavaScript as part of servicing a request. For example, you may want to accumulate the JavaScript as part of an Ajax response or a Comet Rendering or as part of a regular HTML rendering. Call S.appendJs(jsCmd). The accumulated Javascript will be emitted as part of the response, wrapped in an OnLoad to ensure that it executes after the entire dom is available. If for some reason you need to run javascript at the top-level scope, use appendGlobalJs.

Definition Classes: S

def appendNotices(list: Seq[(Value, NodeSeq, Box[String])]): Unit

Add a whole list of notices

Definition Classes: S

final def asInstanceOf[T0]: T0

Definition Classes: Any

def assertExceptionThrown(): Unit

An exception was thrown during the processing of this request.

An exception was thrown during the processing of this request. This is tested to see if the transaction should be rolled back

Definition Classes: S

def atEndOfBody(): List[Elem]

Get the accumulated Elems for the end of the body

Definition Classes: S
See also: putAtEndOfBody

def attrs: List[(Either[String, (String, String)], String)]

Get a list of current attributes.

Get a list of current attributes. Each attribute item is a pair of (key,value). The key is an Either that depends on whether the attribute is prefixed or not. If the attribute is prefixed, the key is a Right((prefix, name)). If the attribute is unprefixed then the key is a Left(name). For example, the following table shows how various tag attributes would be represented:

Snippet Tag	Parsed attrs
<lift:MySnippet testname="test" />	List((Left("testname"), "test"))
<lift:MySnippet anchor:name="test" />	List((Right(("anchor", "name")), "test"))

The prefixedAttrsToMap method provides a convenient way to retrieve only attributes with a given prefix. The prefixedAttrsToMetaData method can be used to add attributes onto an XML node

Definition Classes: S
See also: # prefixedAttrsToMetaData ( String, Map )
# prefixedAttrsToMetaData ( String )
# prefixedAttrsToMap ( String, Map )
# prefixedAttrsToMap ( String )

def attrsFlattenToMap: Map[String, String]

Converts the S.attrs to a Map[String, String].

Converts the S.attrs to a Map[String, String]. The key of the map depends on whether the attribute is prefixed or not. Prefixed attributes have keys of the form "prefix:name", while unprefixed attributes have keys of the form "name". If you only want attributes for a specific prefix, use prefixedAttrsToMap.

Definition Classes: S
See also: # prefixedAttrsToMap ( String, Map )
# prefixedAttrsToMap ( String )

def attrsToMetaData(predicate: (String) ⇒ Boolean): MetaData

Similar to S.attrsToMetaData, but lets you specify a predicate function that filters the generated MetaData.

Similar to S.attrsToMetaData, but lets you specify a predicate function that filters the generated MetaData. For example, if you only wanted the "id" attribute, you could do:

val myDiv = (

 {...} ) % S.attrsToMetaData(_.equalsIgnoreCase("id"))

predicate: The predicate function which is executed for each attribute name. If the function returns true, then the attribute is included in the MetaData.

Definition Classes: S
See also: # attrsToMetaData

def attrsToMetaData: MetaData

Converts S.attrs attributes to a MetaData object that can be used to add attributes to one or more XML elements.

Converts S.attrs attributes to a MetaData object that can be used to add attributes to one or more XML elements. Similar to prefixedAttrsToMetaData, except that it handles both prefixed and unprefixed attributes. This version of the method will use all of the currently set attributes from S.attrs. If you want to filter it, use the attrsToMetaData(String => Boolean) version, which allows you to specify a predicate function for filtering. For example, if you want all of the current attributes to be added to a div tag, you could do:

val myDiv = (

 {...} ) % S.attrsToMetaData

returns: a MetaData instance representing all attributes in S.attrs

Definition Classes: S
See also: # attrsToMetaData ( String = > Boolean )

def callOnce[T](f: ⇒ T): T

If you bind functions (i.e.

If you bind functions (i.e. using SHtml helpers) inside the closure passed to callOnce, after your function is invoked, it will be automatically removed from functions cache so that it cannot be invoked again.

Definition Classes: S

lazy val chromeVersion: Box[Double]

Definition Classes: UserAgentCalculator

def clearAttrs[T](f: ⇒ T): T

Sometimes, in the course of eager evaluation, it becomes necessary to clear attribtues so they do not polute the eagerly evaluated stuff.

Sometimes, in the course of eager evaluation, it becomes necessary to clear attribtues so they do not polute the eagerly evaluated stuff. When you need to clear the attributes, wrap your code block in clearAttrs and have fun.

T: the return type of the code block
f: the call-by-name code block to run where the attributes are clear
returns: the return value of the code block

Definition Classes: S

def clearCurrentNotices: Unit

Clears up the notices

Definition Classes: S

def clearFunctionMap: Unit

Clears the function map.

Clears the function map. potentially very destuctive... use at your own risk!

Definition Classes: S

def clearHighLevelSessionDispatcher: Box[Unit]

Clears all custom dispatch functions from the current session.

Clears all custom dispatch functions from the current session. See addHighLevelSessionDispatcher for an example of usage.

Definition Classes: S
See also: # clearHighLevelSessionDispatcher
# addHighLevelSessionDispatcher
LiftRules.dispatch
LiftRules.DispatchPF

def clearSessionRewriter: Box[Unit]

Clears the per-session rewrite table.

Clears the per-session rewrite table. See addSessionRewriter for an example of usage.

Definition Classes: S
See also: # removeSessionRewriter
# addSessionRewriter
LiftRules.rewrite

def clone(): AnyRef

Attributes: protected[java.lang]
Definition Classes: AnyRef
Annotations: @throws( ... )

def containerRequest: Box[HTTPRequest]

The current container request

Definition Classes: S

def containerSession: Box[HTTPSession]

Returns the HttpSession

Definition Classes: S

def contextFuncBuilder(f: AFuncHolder): AFuncHolder

Wrap an AFuncHolder with the current snippet and Loc context so that for Ajax calls, the original snippets, RequestVars and Loc (location) are populated

f: the AFuncHolder that you want to wrap with execution context

Definition Classes: S

def contextPath: String

The current context path for the deployment.

Definition Classes: S

def cookieValue(name: String): Box[String]

Get the cookie value for the given cookie

Definition Classes: S

def createJsonFunc(name: Box[String], onError: Box[JsCmd], pfp: PFPromoter[JValue, JsCmd]): (JsonCall, JsCmd)

Build a handler for incoming JSON commands based on the new Json Parser.

Build a handler for incoming JSON commands based on the new Json Parser. You can use the helpful Extractor in net.liftweb.util.JsonCommand

name: -- the optional name of the command (placed in a comment for testing)
onError: -- the JavaScript to execute client-side if the request is not processed by the server
returns: ( JsonCall, JsCmd )

Definition Classes: S

def createJsonFunc(onError: JsCmd, f: PFPromoter[JValue, JsCmd]): (JsonCall, JsCmd)

Build a handler for incoming JSON commands based on the new Json Parser

onError: -- the JavaScript to execute client-side if the request is not processed by the server
f: - partial function against a returning a JsCmds
returns: ( JsonCall, JsCmd )

Definition Classes: S

def createJsonFunc(f: PFPromoter[JValue, JsCmd]): (JsonCall, JsCmd)

Build a handler for incoming JSON commands based on the new Json Parser

f: - partial function against a returning a JsCmds
returns: ( JsonCall, JsCmd )

Definition Classes: S

def currentAttrs: MetaData

Retrieves the attributes from the most recently executed snippet element.

For example, given the snippets:

<lift:MyStuff.snippetA foo="bar">
  <lift.MyStuff.snippetB>...</lift.MyStuff.snippetB>
</lift:MyStuff.snippetA>

S.currentAttrs will return Nil.

If you want a particular attribute, the S.currentAttr helper object simplifies things considerably.

Definition Classes: S

def currentAttrsToMetaData(predicate: (String) ⇒ Boolean): MetaData

Similar to S.attrsToMetaData, but lets you specify a predicate function that filters the generated MetaData.

Similar to S.attrsToMetaData, but lets you specify a predicate function that filters the generated MetaData. For example, if you only wanted the "id" attribute, you could do:

val myDiv = (

 {...} ) % S.attrsToMetaData(_.equalsIgnoreCase("id"))

predicate: The predicate function which is executed for each attribute name. If the function returns true, then the attribute is included in the MetaData.

Definition Classes: S
See also: # attrsToMetaData

def currentAttrsToMetaData: MetaData

Converts S.attrs attributes to a MetaData object that can be used to add attributes to one or more XML elements.

Converts S.attrs attributes to a MetaData object that can be used to add attributes to one or more XML elements. Similar to prefixedAttrsToMetaData, except that it handles both prefixed and unprefixed attributes. This version of the method will use all of the currently set attributes from S.attrs. If you want to filter it, use the currentAttrsToMetaData(String => Boolean) version, which allows you to specify a predicate function for filtering. For example, if you want all of the current attributes to be added to a div tag, you could do:

val myDiv = (

 {...} ) % S.attrsToMetaData

returns: a MetaData instance representing all attributes in S.attrs

Definition Classes: S
See also: # attrsToMetaData ( String = > Boolean )

def currentCometActor: Box[LiftCometActor]

Definition Classes: S

def currentSnippet: Box[String]

Definition Classes: S

def currentSnippetNodeSeq: Box[NodeSeq]

The current raw NodeSeq that resulted in a snippet invocation

returns: The current raw NodeSeq that resulted in a snippet invocation

Definition Classes: S

def deleteCookie(name: String): Unit

Deletes the cookie from the user's browser.

name: the name of the cookie to delete

Definition Classes: S
See also: # deleteCookie ( Cookie )
# addCookie ( Cookie )
net.liftweb.http.provider.HTTPCookie

def deleteCookie(cookie: HTTPCookie): Unit

Deletes the cookie from the user's browser.

cookie: the Cookie to delete

Definition Classes: S
See also: # deleteCookie ( String )
# addCookie ( Cookie )
net.liftweb.http.provider.HTTPCookie

def disableTestFuncNames[T](f: ⇒ T): T

Definition Classes: S

def disableTestFuncNames_?: Boolean

Definition Classes: S

def eagerEval: (NodeSeq) ⇒ NodeSeq

A function that will eagerly evaluate a template.

Definition Classes: S

def encodeURL(url: String): String

Decorates an URL with jsessionid parameter in case cookies are disabled from the container.

Decorates an URL with jsessionid parameter in case cookies are disabled from the container. Also it appends general purpose parameters defined by LiftRules.urlDecorate

Definition Classes: S

final def eq(arg0: AnyRef): Boolean

Definition Classes: AnyRef

def equals(arg0: Any): Boolean

Definition Classes: AnyRef → Any

def error(vi: List[FieldError]): Unit

Sets an ERROR notices from a List[FieldError]

Definition Classes: S

def error(id: String, n: String): Unit

Sets an ERROR notice as plain text and associates it with an id

Definition Classes: S

def error(id: String, n: NodeSeq): Unit

Sets an ERROR notice as an XML sequence and associates it with an id

Definition Classes: S

def error(n: NodeSeq): Unit

Sets an ERROR notice as an XML sequence

Definition Classes: S

def error(n: String): Unit

Sets an ERROR notice as a plain text

Definition Classes: S

def errors: List[(NodeSeq, Box[String])]

Returns only ERROR notices

Definition Classes: S

def eval(template: NodeSeq, snips: (String, (NodeSeq) ⇒ NodeSeq)*): Box[NodeSeq]

Evaluate a template for snippets.

Evaluate a template for snippets. This can be used to run a template from within some other Lift processing, such as a snippet or view.

template: the HTML template to run through the Snippet re-writing process
snips: any snippet mapping specific to this template run
returns: a Full Box containing the processed template, or a Failure if the template could not be found.

Definition Classes: S

def exceptionThrown_?: Boolean

Was an exception thrown during the processing of the current request?

Definition Classes: S

def finalize(): Unit

Attributes: protected[java.lang]
Definition Classes: AnyRef
Annotations: @throws( classOf[java.lang.Throwable] )

def findCookie(name: String): Box[HTTPCookie]

Finds a cookie with the given name that was sent in the request.

name: - the name of the cookie to find
returns: Full ( cookie ) if the cookie exists, Empty otherwise

Definition Classes: S
See also: # deleteCookie ( String )
# deleteCookie ( Cookie )
# addCookie ( Cookie )
# receivedCookies
net.liftweb.http.provider.HTTPCookie

def findOrCreateComet[T <: LiftCometActor](cometName: Box[String], cometHtml: NodeSeq, cometAttributes: Map[String, String], receiveUpdatesOnPage: Boolean)(implicit cometManifest: Manifest[T]): Box[T]

Find or build a comet actor of the given type T with the given configuration parameters.

Find or build a comet actor of the given type T with the given configuration parameters. If a comet of that type with that name already exists, it is returned; otherwise, a new one of that type is created and set up, then returned.

If receiveUpdates is true, updates to this comet will be pushed to the page currently being rendered or to the page that is currently invoking an AJAX callback. You can also separately register a comet to receive updates like this using {S.addComet}.

Definition Classes: S

def findOrCreateComet(cometType: String, cometName: Box[String] = Empty, cometHtml: NodeSeq = NodeSeq.Empty, cometAttributes: Map[String, String] = Map.empty, receiveUpdatesOnPage: Boolean = false): Box[LiftCometActor]

As with {findOrBuildComet[T]}, but specify the type as a String.

As with {findOrBuildComet[T]}, but specify the type as a String. If the comet doesn't already exist, the comet type is first looked up via LiftRules.cometCreationFactory, and then as a class name in the comet packages designated by LiftRules.buildPackage("comet").

If receiveUpdates is true, updates to this comet will be pushed to the page currently being rendered or to the page that is currently invoking an AJAX callback. You can also separately register a comet to receive updates like this using {S.addComet}.

Definition Classes: S

lazy val firefoxVersion: Box[Double]

Definition Classes: UserAgentCalculator

def fmapFunc[T](in: AFuncHolder)(f: (String) ⇒ T): T

Maps a function with an random generated and name

Definition Classes: S

def forHead(): List[Elem]

Get the accumulated Elems for head

Definition Classes: S
See also: putInHead

def formFuncName: String

Definition Classes: S

def formGroup[T](group: Int)(f: ⇒ T): T

Definition Classes: S

def functionLifespan[T](span: Boolean)(f: ⇒ T): T

Functions that are mapped to HTML elements are, by default, garbage collected if they are not seen in the browser in the last 10 minutes (defined in LiftRules.unusedFunctionsLifeTime).

Functions that are mapped to HTML elements are, by default, garbage collected if they are not seen in the browser in the last 10 minutes (defined in LiftRules.unusedFunctionsLifeTime). In some cases (e.g., JSON handlers), you may want to extend the lifespan of the functions to the lifespan of the session.

span: If true, extend the mapped function lifetime to the life of the session
f: A function to execute in the context of specified span

Definition Classes: S
See also: LiftRules.unusedFunctionsLifeTime

def functionLifespan_?: Boolean

Returns whether functions are currently extended to the lifetime of the session.

returns: true if mapped functions will currently last the life of the session.

Definition Classes: S

def functionMap: Map[String, AFuncHolder]

Get a map of function name bindings that are used for form and other processing.

Get a map of function name bindings that are used for form and other processing. Using these bindings is considered advanced functionality.

Definition Classes: S

def generateFuncName: String

Standard func-name logic.

Standard func-name logic. This is the default routine.

Definition Classes: S

def generatePredictableFuncName: String

Generates a func-name based on the location in the call-site source code.

Definition Classes: S

def generateTestFuncName: String

Default func-name logic during test-mode.

Definition Classes: S

def get(what: String): Box[String]

Returns the LiftSession parameter denominated by 'what'.

Definition Classes: S
See also: # unsetSessionAttribute
# unset
# setSessionAttribute
# set
# getSessionAttribute

def getAllNotices: List[(Value, NodeSeq, Box[String])]

Returns the current and "old" notices

Definition Classes: S

final def getClass(): Class[_]

Definition Classes: AnyRef → Any

def getDocType: (Boolean, Box[String])

Returns the document type that was set for the response.

Returns the document type that was set for the response. The default is XHTML 1.0 Transitional.

Definition Classes: S
See also: DocType
setDocType

def getNotices: List[(Value, NodeSeq, Box[String])]

Returns the current notices

Definition Classes: S

def getRequestHeader(name: String): Box[String]

Returns the current value of the given HTTP request header as a Box.

Returns the current value of the given HTTP request header as a Box. This is really just a thin wrapper on Req.header(String). For response headers, see S.getHeaders, S.setHeader, or S.getHeader.

name: The name of the HTTP header to retrieve
returns: A Full(value) or Empty if the header isn't set

Definition Classes: S
See also: # getHeaders ( List[ ( String, String ) ] )
# setHeader ( String, String )
# getHeader ( String )
Req # header ( String )

def getResponseHeader(name: String): Box[String]

Returns the current set value of the given HTTP response header as a Box.

Returns the current set value of the given HTTP response header as a Box. If you want a request header, use Req.getHeader or S.getRequestHeader.

name: The name of the HTTP header to retrieve
returns: A Full(value) or Empty if the header isn't set

Definition Classes: S
See also: # getRequestHeader ( String )
# getResponseHeaders ( List[ ( String, String ) ] )
# setHeader ( String, String )

def getResponseHeaders(in: List[(String, String)]): List[(String, String)]

Returns the currently set HTTP response headers as a List[(String, String)].

Returns the currently set HTTP response headers as a List[(String, String)]. To retrieve a specific response header, use S.getResponseHeader. If you want to get request headers (those sent by the client), use Req.getHeaders or S.getRequestHeader.

Definition Classes: S
See also: # getRequestHeader ( String )
# getResponseHeader ( String )
# setHeader ( String, String )

def getSessionAttribute(what: String): Box[String]

Returns the HttpSession parameter denominated by 'what'

Definition Classes: S
See also: # unsetSessionAttribute
# unset
# setSessionAttribute
# set
# get

def get_?: Boolean

Test the current request to see if it's a GET.

Test the current request to see if it's a GET. This is a thin wrapper on Req.get_?

returns: true if the request is a GET, false otherwise.

Definition Classes: S
See also: Req.get_ ?

def hashCode(): Int

Definition Classes: AnyRef → Any

def highLevelSessionDispatchList: List[DispatchHolder]

Return the list of DispatchHolders set for this session.

Definition Classes: S
See also: DispatchHolder

def highLevelSessionDispatcher: List[DispatchPF]

Return a List of the LiftRules.DispatchPF functions that are set for this session.

Return a List of the LiftRules.DispatchPF functions that are set for this session. See addHighLevelSessionDispatcher for an example of how these are used.

Definition Classes: S
See also: # clearHighLevelSessionDispatcher
# removeHighLevelSessionDispatcher ( String )
# addHighLevelSessionDispatcher ( String, LiftRules.DispatchPF )
LiftRules.DispatchPF

def hostAndPath: String

The host and path of the request up to and including the context path.

The host and path of the request up to and including the context path. This does not include the template path or query string.

Definition Classes: S

def hostName: String

The hostname to which the request was sent.

The hostname to which the request was sent. This is taken from the "Host" HTTP header, or if that does not exist, the DNS name or IP address of the server.

Definition Classes: S

def htmlProperties: HtmlProperties

Get the current instance of HtmlProperties

Definition Classes: S

def idMessages(f: ⇒ List[(NodeSeq, Box[String])]): List[(String, List[NodeSeq])]

Returns the messages that are associated with any id.

Returns the messages that are associated with any id. Messages associated with the same id will be enlisted.

f: - the function that returns the messages

Definition Classes: S

lazy val ieIE10: Boolean

Definition Classes: UserAgentCalculator

lazy val ieVersion: Box[Int]

Definition Classes: UserAgentCalculator

def ignoreFailedSnippets: Boolean

returns: should failed snippets be ignored and have the original NodeSeq returned?

Definition Classes: S

def inStatefulScope_?: Boolean

This method returns true if the S object has been initialized for our current scope.

This method returns true if the S object has been initialized for our current scope. If the S object has not been initialized then functionality on S will not work.

Definition Classes: S

def init[B](request: Box[Req], session: LiftSession)(f: ⇒ B): B

Initialize the current request session.

Initialize the current request session. Generally this is handled by Lift during request processing, but this method is available in case you want to use S outside the scope of a request (standard HTTP or Comet).

request: The Req instance for this request
session: the LiftSession for this request
f: Function to execute within the scope of the request and session

Definition Classes: S

def initIfUninitted[B](session: LiftSession)(f: ⇒ B): B

Initialize the current request session if it's not already initialized.

Initialize the current request session if it's not already initialized. Generally this is handled by Lift during request processing, but this method is available in case you want to use S outside the scope of a request (standard HTTP or Comet).

session: the LiftSession for this request
f: A function to execute within the scope of the session

Definition Classes: S

def invokedAs: String

Returns the 'type' S attribute.

Returns the 'type' S attribute. This corresponds to the current Snippet's name. For example, the snippet:

  <lift:Hello.world />

Will return "Hello.world".

Definition Classes: S

def isChrome: Boolean

Definition Classes: UserAgentCalculator

lazy val isChrome2: Boolean

Definition Classes: UserAgentCalculator

lazy val isChrome3: Boolean

Definition Classes: UserAgentCalculator

def isChrome3_+: Boolean

Definition Classes: UserAgentCalculator

lazy val isChrome4: Boolean

Definition Classes: UserAgentCalculator

lazy val isChrome5: Boolean

Definition Classes: UserAgentCalculator

lazy val isChrome6: Boolean

Definition Classes: UserAgentCalculator

def isFirefox: Boolean

Definition Classes: UserAgentCalculator

lazy val isFirefox2: Boolean

Definition Classes: UserAgentCalculator

lazy val isFirefox3: Boolean

Definition Classes: UserAgentCalculator

lazy val isFirefox35: Boolean

Definition Classes: UserAgentCalculator

def isFirefox35_+: Boolean

Definition Classes: UserAgentCalculator

lazy val isFirefox36: Boolean

Definition Classes: UserAgentCalculator

lazy val isFirefox40: Boolean

Definition Classes: UserAgentCalculator

lazy val isIE: Boolean

Definition Classes: UserAgentCalculator

lazy val isIE11: Boolean

Definition Classes: UserAgentCalculator

lazy val isIE6: Boolean

Definition Classes: UserAgentCalculator

lazy val isIE7: Boolean

Definition Classes: UserAgentCalculator

lazy val isIE8: Boolean

Definition Classes: UserAgentCalculator

lazy val isIE9: Boolean

Definition Classes: UserAgentCalculator

lazy val isIPad: Boolean

Is the Req coming from an iPad

Definition Classes: UserAgentCalculator

lazy val isIPhone: Boolean

Is the Req coming from an iPhone

Definition Classes: UserAgentCalculator

final def isInstanceOf[T0]: Boolean

Definition Classes: Any

def isOpera: Boolean

Definition Classes: UserAgentCalculator

lazy val isOpera9: Boolean

Definition Classes: UserAgentCalculator

def isSafari: Boolean

Definition Classes: UserAgentCalculator

def isSafari2: Boolean

Definition Classes: UserAgentCalculator

lazy val isSafari3: Boolean

Definition Classes: UserAgentCalculator

def isSafari3_+: Boolean

Definition Classes: UserAgentCalculator

lazy val isSafari4: Boolean

Definition Classes: UserAgentCalculator

lazy val isSafari5: Boolean

Definition Classes: UserAgentCalculator

def jsToAppend(clearAfterReading: Boolean = false): List[JsCmd]

Get the accumulated JavaScript

Definition Classes: S
See also: appendJs

def jsonFmapFunc[T](in: (JValue) ⇒ JsCmd)(f: (String) ⇒ T)(implicit dummy: AvoidTypeErasureIssues1): T

Maps a function that will be called with a parsed JValue and should return a JsCmd to be sent back to the browser.

Maps a function that will be called with a parsed JValue and should return a JsCmd to be sent back to the browser. Note that if the passed JSON does not parse, the function will not be invoked.

Definition Classes: S

def legacyIeCompatibilityMode: Boolean

A boolean indicating whether or not the response should be rendered with special accomodations for IE 6 / 7 / 8 compatibility.

returns: true if this response should be rendered in IE 6/7/8 compatibility mode.

Definition Classes: S
See also: Req.isIE
Req.isIE8
Req.isIE7
Req.isIE6
LiftRules.calcIEMode
LiftSession.legacyIeCompatibilityMode

def liftCoreResourceBundle: Box[ResourceBundle]

Get the lift core resource bundle for the current locale as defined by the LiftRules.liftCoreResourceName varibale.

Definition Classes: S
See also: LiftRules.liftCoreResourceName

def loc(str: String, xform: (NodeSeq) ⇒ NodeSeq): Box[NodeSeq]

Localize the incoming string based on a resource bundle for the current locale.

Localize the incoming string based on a resource bundle for the current locale. The localized string is converted to an XML element if necessary via the LiftRules.localizeStringToXml function (the default behavior is to wrap it in a Text element). If the lookup fails for a given resource bundle (e.g. a null is returned), then the LiftRules.localizationLookupFailureNotice function is called with the input string and locale. The function is applied to the result/

str: the string or ID to localize
xform: the function that transforms the NodeSeq
returns: A Full box containing the localized XML or Empty if there's no way to do localization

Definition Classes: S
See also: # loc ( String, NodeSeq )
LiftRules.localizationLookupFailureNotice
LiftRules.localizeStringToXml
# resourceBundles
# locale

def loc(str: String, dflt: NodeSeq): NodeSeq

Localize the incoming string based on a resource bundle for the current locale, with a default value to to return if localization fails.

str: the string or ID to localize
dflt: the default string to return if localization fails
returns: the localized XHTML or default value

Definition Classes: S
See also: # loc ( String )

def loc(str: String): Box[NodeSeq]

Localize the incoming string based on a resource bundle for the current locale.

Localize the incoming string based on a resource bundle for the current locale. The localized string is converted to an XML element if necessary via the LiftRules.localizeStringToXml function (the default behavior is to wrap it in a Text element). If the lookup fails for a given resource bundle (e.g. a null is returned), then the LiftRules.localizationLookupFailureNotice function is called with the input string and locale.

str: the string or ID to localize
returns: A Full box containing the localized XML or Empty if there's no way to do localization

Definition Classes: S
See also: # loc ( String, NodeSeq )
LiftRules.localizationLookupFailureNotice
LiftRules.localizeStringToXml
# resourceBundles
# locale

def locale: Locale

Returns the Locale for this request based on the LiftRules.localeCalculator method.

Definition Classes: S
See also: java.util.Locale
LiftRules.localeCalculator ( HTTPRequest )

def locateMappedSnippet(name: String): Box[(NodeSeq) ⇒ NodeSeq]

Definition Classes: S

def locateSnippet(name: String): Box[(NodeSeq) ⇒ NodeSeq]

Finds a snippet function by name.

Definition Classes: S
See also: LiftRules.snippets

def location: Box[Loc[_]]

Definition Classes: S

def logQuery(query: String, time: Long): ListBuffer[(String, Long)]

Log a query for the given request.

Log a query for the given request. The query log can be tested to see if queries for the particular page rendering took too long. The query log starts empty for each new request. net.liftweb.mapper.DB.queryCollector is a method that can be used as a log function for the net.liftweb.mapper.DB.addLogFunc method to enable logging of Mapper queries. You would set it up in your bootstrap like:

import net.liftweb.mapper.DB
import net.liftweb.http.S
class Boot  {
  def boot  {
    ...
    DB.addLogFunc(DB.queryCollector)
    ...
}
}

Note that the query log is simply stored as a List and is not sent to any output by default. To retrieve the List of query log items, use S.queryLog. You can also provide your own analysis function that will process the query log via S.addAnalyzer.

Definition Classes: S
See also: net.liftweb.mapper.DB.addLogFunc
# addAnalyzer
# queryLog

def loggedIn_?: Boolean

This method is a convenience accessor for LiftRules.loggedInTest.

This method is a convenience accessor for LiftRules.loggedInTest. You can define your own function to check to see if a user is logged in there and this will call it.

returns: the value from executing LiftRules.loggedInTest, or false if a test function is not defined.

Definition Classes: S
See also: LiftRules.loggedInTest

val logger: Logger

Attributes: protected
Definition Classes: Loggable
Annotations: @transient()

def mapFuncToURI(uri: String, f: () ⇒ Unit): String

Attaches to this uri and parameter that has function f associated with.

Attaches to this uri and parameter that has function f associated with. When this request is submitted to server the function will be executed and then it is automatically cleaned up from functions caches.

Definition Classes: S

def mapSnippet(name: String, func: (NodeSeq) ⇒ NodeSeq): Unit

Associates a name with a snippet function 'func'.

Associates a name with a snippet function 'func'. This can be used to change a snippet mapping on a per-request basis. For example, if we have a page that we want to change behavior on based on query parameters, we could use mapSnippet to programmatically determine which snippet function to use for a given snippet in the template. Our code would look like:

  import scala.xml.{ NodeSeq,Text }
  class SnipMap  {
  def topSnippet (xhtml : NodeSeq) : NodeSeq =  {
  if (S.param("showAll").isDefined)  {
  S.mapSnippet("listing", listing)
  } else  {
  S.mapSnippet("listing",  { ignore => Text("") } )
  }

  ...
  }

  def listing(xhtml : NodeSeq) : NodeSeq =  {
  ...
  }

Then, your template would simply look like:

  <lift:surround with="default" at="content">
  ...
  <p><lift:SnipMap.topSnippet /></p>
  <p><lift:listing /></p>
  </lift:surround>

Snippets are processed in the order that they're defined in the template, so if you want to use this approach make sure that the snippet that defines the mapping comes before the snippet that is being mapped. Also note that these mappings are per-request, and are discarded after the current request is processed.

name: The name of the snippet that you want to map (the part after "<lift:").
func: The snippet function to map to.

Definition Classes: S

def mapSnippetsWith[T](snips: (String, (NodeSeq) ⇒ NodeSeq)*)(f: ⇒ T): T

The are times when it's helpful to define snippets for a certain call stack...

The are times when it's helpful to define snippets for a certain call stack... snippets that are local purpose. Use doWithSnippets to temporarily define snippet mappings for the life of f.

Definition Classes: S

def mapToAttrs(in: Map[String, String]): MetaData

Converts a Map[String, String] into a MetaData instance.

Converts a Map[String, String] into a MetaData instance. This can be used to add attributes to an XML element based on a map of attribute->value pairs. See prefixedAttrsToMetaData(String,Map) for an example.

in: The map of attributes
returns: MetaData representing the Map of attributes as unprefixed attributes.

Definition Classes: S
See also: # prefixedAttrsToMetaData ( String, Map )

def messages(f: ⇒ List[(NodeSeq, Box[String])]): List[NodeSeq]

Returns all messages, associated with any id or not

f: - the function that returns the messages

Definition Classes: S

def messagesById(id: String)(f: ⇒ List[(NodeSeq, Box[String])]): List[NodeSeq]

Returns the messages provided by list function that are associated with id

id: - the lookup id
f: - the function that returns the messages

Definition Classes: S

final def ne(arg0: AnyRef): Boolean

Definition Classes: AnyRef

def noIdMessages(f: ⇒ List[(NodeSeq, Box[String])]): List[NodeSeq]

Returns the messages that are not associated with any id

f: - the function that returns the messages

Definition Classes: S

def notice(id: String, n: String): Unit

Sets a NOTICE notice as plai text and associates it with an id

Definition Classes: S

def notice(id: String, n: NodeSeq): Unit

Sets a NOTICE notice as and XML sequence and associates it with an id

Definition Classes: S

def notice(n: NodeSeq): Unit

Sets a NOTICE notice as an XML sequence

Definition Classes: S

def notice(n: String): Unit

Sets a NOTICE notice as plain text

Definition Classes: S

def notices: List[(NodeSeq, Box[String])]

Returns only NOTICE notices

Definition Classes: S

final def notify(): Unit

Definition Classes: AnyRef

final def notifyAll(): Unit

Definition Classes: AnyRef

def oneShot[T](f: ⇒ T): T

All functions created inside the oneShot scope will only be called once and their results will be cached and served again if the same function is invoked

Definition Classes: S

def originalRequest: Box[Req]

If this is an Ajax request, return the original request that created the page.

If this is an Ajax request, return the original request that created the page. The original request is useful because it has the original path which is helpful for localization purposes.

returns: the original request or if that's not available, the current request

Definition Classes: S

def overrideSnippetForClass(cls: String, inst: DispatchSnippet): Unit

Register a stateful snippet for a given class name.

Register a stateful snippet for a given class name. The addSnippetForClass method is preferred

Definition Classes: S

def param(n: String): Box[String]

Returns the HTTP parameter having 'n' name

Definition Classes: S → HasParams

def params(n: String): List[String]

Returns all the HTTP parameters having 'n' name

Definition Classes: S

def post_?: Boolean

Test the current request to see if it's a POST.

Test the current request to see if it's a POST. This is a thin wrapper over Req.post_?

returns: true if the request is a POST request, false otherwise.

Definition Classes: S

def prefixedAttrsToMap(prefix: String): Map[String, String]

Returns the S attributes that are prefixed by 'prefix' parameter as a Map[String, String]

prefix: the prefix to be matched
returns: Map[String, String]

Definition Classes: S
See also: # prefixedAttrsToMetaData ( String, Map )
# prefixedAttrsToMetaData ( String )
# prefixedAttrsToMap ( String, Map )

def prefixedAttrsToMap(prefix: String, start: Map[String, String]): Map[String, String]

Returns the S attributes that are prefixed by 'prefix' parameter as a Map[String, String] that will be 'merged' with the 'start' Map

prefix: the prefix to be matched
start: the initial Map
returns: Map[String, String]

Definition Classes: S
See also: # prefixedAttrsToMetaData ( String, Map )
# prefixedAttrsToMetaData ( String )
# prefixedAttrsToMap ( String )

def prefixedAttrsToMetaData(prefix: String): MetaData

Similar with prefixedAttrsToMetaData(prefix: String, start: Map[String, String]) but there is no 'start' Map

Definition Classes: S

def prefixedAttrsToMetaData(prefix: String, start: Map[String, String]): MetaData

Returns the S attributes that are prefixed by 'prefix' parameter as a MetaData.

Returns the S attributes that are prefixed by 'prefix' parameter as a MetaData. The start Map will be 'merged' with the Map resulted after prefix matching and the result Map will be converted to a MetaData. The MetaData can be used to add attributes back onto XML elements via Scala's '%' method. For example, if we wanted to add attributes prefixed with "anchor" to any <a> elements we create, we could do something like:

  val myLink = (...) % S.prefixedAttrsToMetaData("anchor", Map("id" -> "myAnchor"))

prefix: the prefix to be matched
start: the initial Map
returns: MetaData representing the combination of current attributes plus the start Map of attributes

Definition Classes: S
See also: # prefixedAttrsToMetaData ( String )
# prefixedAttrsToMap ( String, Map )
# prefixedAttrsToMap ( String )

def putAtEndOfBody(elem: Elem): Unit

Put the given Elem at the end of the body tag.

Definition Classes: S

def putInHead(elem: Elem): Unit

Put the given Elem in the head tag.

Put the given Elem in the head tag. The Elems will be de-dupped so no problems adding the same style tag multiple times

Definition Classes: S

def queryLog: List[(String, Long)]

Get a list of the logged queries.

Get a list of the logged queries. These log entries are added via the logQuery method, which has a more detailed explanation of usage.

Definition Classes: S
See also: # addAnalyzer
# logQuery ( String, Long )

def queryString: Box[String]

Returns the query string for the current request

Definition Classes: S

def receivedCookies: List[HTTPCookie]

returns: a List of any Cookies that have been set for this Response. If you want a specific cookie, use findCookie.

Definition Classes: S
See also: # deleteCookie ( String )
# deleteCookie ( Cookie )
# addCookie ( Cookie )
# findCookie ( String )
net.liftweb.http.provider.HTTPCookie

def redirectTo(where: String, func: () ⇒ Unit): Nothing

Redirects the browser to a given URL and registers a function that will be executed when the browser accesses the new URL.

Redirects the browser to a given URL and registers a function that will be executed when the browser accesses the new URL. Otherwise the function is exactly the same as S.redirectTo(String), which has example documentation. Note that if the URL that you redirect to must be part of your web application or the function won't be executed. This is because the function is only registered locally.

where: The new URL to redirect to.
func: The function to be executed when the redirect is accessed.

Definition Classes: S
See also: # redirectTo ( String )

def redirectTo(where: String): Nothing

Redirects the browser to a given URL.

Redirects the browser to a given URL. Note that the underlying mechanism for redirects is to throw a ResponseShortcutException, so if you're doing the redirect within a try/catch block, you need to make sure to either ignore the redirect exception or rethrow it. Two possible approaches would be:

  ...
  try  {
    // your code here
    S.redirectTo(...)
} catch  {
    case e: Exception if !e.isInstanceOf[LiftFlowOfControlException] => ...
}

or

  ...
  try  {
    // your code here
    S.redirectTo(...)
} catch  {
    case rse: LiftFlowOfControlException => throw rse
    case e: Exception => ...
}

where: The new URL to redirect to.

Definition Classes: S
See also: # redirectTo ( String, ( ) => Unit)
ResponseShortcutException

def referer: Box[String]

Returns the 'Referer' HTTP header attribute.

Definition Classes: S

def removeHighLevelSessionDispatcher(name: String): Box[HashMap[String, DispatchPF]]

Removes a custom dispatch function for the current session.

Removes a custom dispatch function for the current session. See addHighLevelSessionDispatcher for an example of usage.

name: The name of the custom dispatch to be removed.

Definition Classes: S
See also: # clearHighLevelSessionDispatcher
# addHighLevelSessionDispatcher
LiftRules.dispatch
LiftRules.DispatchPF

def removeSessionRewriter(name: String): Box[HashMap[String, RewritePF]]

Removes the given per-session rewriter.

Removes the given per-session rewriter. See addSessionRewriter for an example of usage.

Definition Classes: S
See also: # clearSessionRewriter
# addSessionRewriter
LiftRules.rewrite

def render(xhtml: NodeSeq, httpRequest: HTTPRequest): NodeSeq

Definition Classes: S

def renderVersion: String

Returns the logical page_id of the current request.

Returns the logical page_id of the current request. All RequestVars for a current page share this id.

Definition Classes: S

def request: Box[Req]

Get a Req representing our current HTTP request.

returns: A Full(Req) if one has been initialized on the calling thread, Empty otherwise.

Definition Classes: S
See also: Req

def resourceBundles(loc: Locale): List[ResourceBundle]

Definition Classes: S

def resourceBundles: List[ResourceBundle]

Get a List of the resource bundles for the current locale.

Get a List of the resource bundles for the current locale. The resource bundles are defined by the LiftRules.resourceNames and LiftRules.resourceBundleFactories variables. If you do not define an entry for a particular key, we fall back to using Lift's core entries.

Definition Classes: S
See also: LiftRules.resourceBundleFactories
LiftRules.resourceNames

def respondAsync(f: ⇒ Box[LiftResponse]): () ⇒ Box[LiftResponse]

Use this in DispatchPF for processing REST requests asynchronously.

Use this in DispatchPF for processing REST requests asynchronously. Note that this must be called in a stateful context, therefore the S state must be a valid one.

f: - the user function that does the actual computation. This function takes one parameter which is the function that must be invoked for returning the actual response to the client. Note that f function is invoked asynchronously in the context of a different thread.

Definition Classes: S

def responseCookies: List[HTTPCookie]

returns: a List of any Cookies that have been added to the response to be sent back to the user. If you want the cookies that were sent with the request, see receivedCookies.

Definition Classes: S
See also: # receivedCookies
net.liftweb.http.provider.HTTPCookie

def runExceptionHandlers(req: Req, orig: Throwable): Box[LiftResponse]

Run any configured exception handlers and make sure errors in the handlers are ignored

Definition Classes: S

def runSnippetsWithIgnoreFailed[T](ignore: Boolean)(f: ⇒ T): T

Set the ignore snippet error mode.

Set the ignore snippet error mode. In this mode, any snippet failures (usually snippets not being invocable) will be ignored and the original NodeSeq will be returned.

This is useful if you want to do an initial pass of a page with a white-list of snippets, but not run every snippet on the page.

T: the return type of the code block
ignore: sets the ignore flag
f: the code block to execute
returns: the return of the code block

Definition Classes: S

def runTemplate(path: List[String], snips: (String, (NodeSeq) ⇒ NodeSeq)*): Box[NodeSeq]

Find and process a template.

Find and process a template. This can be used to load a template from within some other Lift processing, such as a snippet or view. If you just want to retrieve the XML contents of a template, use Templates.apply.

path: The path for the template that you want to process
snips: any snippet mapping specific to this template run
returns: a Full Box containing the processed template, or a Failure if the template could not be found.

Definition Classes: S
See also: TempalateFinder # apply

lazy val safariVersion: Box[Int]

Definition Classes: UserAgentCalculator

def seeOther[T](where: String, func: () ⇒ Unit): T

Redirects the browser to a given URL and registers a function that will be executed when the browser accesses the new URL.

Redirects the browser to a given URL and registers a function that will be executed when the browser accesses the new URL. Otherwise the function is exactly the same as S.seeOther(String), which has example documentation. Note that if the URL that you redirect to must be part of your web application or the function won't be executed. This is because the function is only registered locally.

where: The new URL to redirect to.
func: The function to be executed when the redirect is accessed.

Definition Classes: S
See also: # seeOther ( String )

def seeOther[T](where: String): T

Redirects the browser to a given URL.

Redirects the browser to a given URL. Note that the underlying mechanism for redirects is to throw a ResponseShortcutException, so if you're doing the redirect within a try/catch block, you need to make sure to either ignore the redirect exception or rethrow it. Two possible approaches would be:

  ...
  try  {
    // your code here
    S.seeOther(...)
} catch  {
    case e: Exception if !e.instanceOf[LiftFlowOfControlException] => ...
}

or

  ...
  try  {
    // your code here
    S.seeOther(...)
} catch  {
    case rse: LiftFlowOfControlException => throw rse
    case e: Exception => ...
}

where: The new URL to redirect to.

Definition Classes: S
See also: # seeOther ( String, ( ) => Unit)
ResponseShortcutException

def session: Box[LiftSession]

The current LiftSession.

Definition Classes: S

def sessionFuture[T](task: ⇒ T, scheduler: LAScheduler = LAScheduler): LAFuture[T]

Creates LAFuture instance aware of the current request and session.

Creates LAFuture instance aware of the current request and session. Each LAFuture returned by chained transformation method (e.g. map, flatMap) will be also request/session-aware. However, it's important to bear in mind that initial session or request are not propagated to chained methods. It's required that current execution thread for chained method has request or session available in scope if reading/writing some data to it as a part of chained method execution.

Definition Classes: S

def sessionRewriter: List[RewriteHolder]

Return the list of RewriteHolders set for this session.

Return the list of RewriteHolders set for this session. See addSessionRewriter for an example of how to use per-session rewrites.

Definition Classes: S
See also: LiftRules # rewrite
RewriteHolder

def set(name: String, value: String): Unit

Sets a LiftSession attribute

Definition Classes: S
See also: # unsetSessionAttribute
# unset
# setSessionAttribute
# getSessionAttribute
# get

def setDocType(what: Box[String]): Unit

Sets the document type for the response.

Sets the document type for the response. If this is not set, the DocType for Lift responses defaults to XHTML 1.0 Transitional.

Definition Classes: S
See also: DocType
ResponseInfo.docType
getDocType

def setHeader(name: String, value: String): Unit

Sets a HTTP response header attribute.

Sets a HTTP response header attribute. For example, you could set a "Warn" header in your response:

  ...
  S.setHeader("Warn", "The cheese is old and moldy")
  ...

Definition Classes: S
See also: # getHeaders

def setResponseHeader(name: String, value: String): Unit

Synonym for S.setHeader.

Synonym for S.setHeader. Exists to provide the converse to S.getResponseHeader.

Definition Classes: S

def setSessionAttribute(name: String, value: String): Unit

Sets a HttpSession attribute

Definition Classes: S
See also: # unsetSessionAttribute
# unset
# set
# getSessionAttribute
# get

def skipDocType: Boolean

When this is true, Lift will not emit a DocType definition at the start of the response content.

When this is true, Lift will not emit a DocType definition at the start of the response content. If you're sending XHTML and this is set to true, you need to include the DocType in your template.

Definition Classes: S
See also: # skipDocType_ =(Boolean)

def skipDocType_=(skip: Boolean): Unit

Sets Lift's DocType behavior.

Sets Lift's DocType behavior. If this is set to true, Lift will not emit a DocType definition at the start of the response content. If you're sending XHTML and this is set to true, you need to include the DocType in your template.

skip: Set to true to prevent Lift from emitting a DocType in its response

Definition Classes: S
See also: # skipDocType

def skipXmlHeader: Boolean

If true, then the xml header at the beginning of the returned XHTML page will not be inserted.

Definition Classes: S

def skipXmlHeader_=(in: Boolean): Unit

Set the skipXmlHeader flag

Definition Classes: S

def snippetForClass(cls: String): Box[DispatchSnippet]

Given a snippet class name, return the cached or predefined stateful snippet for that class

Definition Classes: S

def statefulRequest_?: Boolean

Are we currently in the scope of a stateful request

Definition Classes: S

def statelessInit[B](request: Req)(f: ⇒ B): B

Definition Classes: S

implicit def stuff2ToUnpref(in: (Symbol, Any)): UnprefixedAttribute

Definition Classes: S

def synchronizeForSession[T](f: ⇒ T): T

Execute code synchronized to the current session object

Definition Classes: S

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

Definition Classes: AnyRef

def templateFromTemplateAttr: Box[NodeSeq]

Find a template based on the snippet attribute "template"

Definition Classes: S

def timeZone: TimeZone

Return the current timezone based on the LiftRules.timeZoneCalculator method.

Definition Classes: S
See also: java.util.TimeZone
LiftRules.timeZoneCalculator ( HTTPRequest )

def toString(): String

Definition Classes: AnyRef → Any

implicit def tuple2FieldError(t: (FieldIdentifier, NodeSeq)): FieldError

Definition Classes: S

def unset(name: String): Unit

Removes a LiftSession attribute

Definition Classes: S
See also: # unsetSessionAttribute
# setSessionAttribute
# set
# getSessionAttribute
# get

def unsetSessionAttribute(name: String): Unit

Removes a HttpSession attribute

Definition Classes: S
See also: # unset
# setSessionAttribute
# set
# getSessionAttribute
# get

def uri: String

The URI of the current request (not re-written).

The URI of the current request (not re-written). The URI is the portion of the request URL after the context path. For example, with a context path of "myApp", Lift would return the following URIs for the given requests:

HTTP request	URI
http://foo.com/myApp/foo/bar.html		/foo/bar.html
http://foo.com/myApp/test/		/test/
http://foo.com/myApp/item.html?id=42		/item.html

If you want the full URI, including the context path, you should retrieve it from the underlying HTTPRequest. You could do something like:

  val fullURI = S.request.map(_.request.getRequestURI) openOr ("Undefined")

The URI may be used to provide a link back to the same page as the current request:

  bind(...,
       "selflink" -> SHtml.link(S.uri,  { () => ... }, Text("Self link")),
       ...)

Definition Classes: S
See also: net.liftweb.http.provider.HTTPRequest.uri
Req.uri

def uriAndQueryString: Box[String]

Definition Classes: S

def userAgent: Box[String]

The user agent of the current request, if any.

Definition Classes: S → UserAgentCalculator

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 warning(id: String, n: String): Unit

Sets a WARNING notice as plain text and associates it with an id

Definition Classes: S

def warning(id: String, n: NodeSeq): Unit

Sets a WARNING notice as an XML sequence and associates it with an id

Definition Classes: S

def warning(n: NodeSeq): Unit

Sets a WARNING notice as an XML sequence

Definition Classes: S

def warning(n: String): Unit

Sets a WARNING notice as plain text

Definition Classes: S

def warnings: List[(NodeSeq, Box[String])]

Returns only WARNING notices

Definition Classes: S

def withAttrs[T](attrs: MetaData)(f: ⇒ T): T

Temporarily adds the given attributes to the current set, then executes the given function.

attrs: The attributes to set temporarily

Definition Classes: S

def withCurrentSnippetNodeSeq[T](ns: NodeSeq)(f: ⇒ T): T

The code block is executed while setting the current raw NodeSeq for access elsewhere

T: the type that f returns
ns: the current NodeSeq
f: the call-by-name value to return (the code block to execute)
returns: the value the the expression returns

Definition Classes: S

object AFuncHolder extends Serializable

The companion object that generates AFuncHolders from other functions

object BinFuncHolder extends Serializable

object LFuncHolder extends Serializable

object NFuncHolder extends Serializable

object PFPromoter extends Serializable

object SFuncHolder extends Serializable

object attr extends AttrHelper[Box]

Used to get an attribute by its name.

Used to get an attribute by its name. There are several means to getting attributes:

  // Get a Box for the attribute:
  val myAttr = S.attr("test") openOr "Not found"

  // Get an attribute or return a default value:
  val myAttr = S.attr("name", "Fred")

  // Apply a transform function on the attribute value, or return an Empty:
  val pageSize = S.attr("count", _.toInt) openOr 20

  // There are also prefixed versions:
  val prefixedAttr = S.attr("prefix", "name") openOr "Not found"

Note that this uses the data held in S.attrs, which means that it will find attributes through the entire snippet nesting stack. For example, given the snippets:

<lift:MyStuff.snippetA foo="bar">
  <lift.MyStuff.snippetB>...</lift.MyStuff.snippetB>
</lift:MyStuff.snippetA>

Calling S.attr("foo") from snippetB will return Full("bar").

Definition Classes: S

object currentAttr extends AttrHelper[Box]

Used to get an attribute by its name from the current snippet element.

Used to get an attribute by its name from the current snippet element. There are several means to getting attributes:

  // Get a Box for the attribute:
  val myAttr = S.currentAttr("test") openOr "Not found"

  // Get an attribute or return a default value:
  val myAttr = S.currentAttr("name", "Fred")

  // Apply a transform function on the attribute value, or return an Empty:
  val pageSize = S.currentAttr("count", _.toInt) openOr 20

  // There are also prefixed versions:
  val prefixedAttr = S.currentAttr("prefix", "name") openOr "Not found"

Note that this uses the data held in S.currentAttrs, which means that it will only find attributes from the current snippet element. For example, given the snippets:

<lift:MyStuff.snippetA foo="bar">
  <lift.MyStuff.snippetB>...</lift.MyStuff.snippetB>
</lift:MyStuff.snippetA>

Calling S.currentAttr("foo") from snippetB will return Empty.

Definition Classes: S

Packages

S

Companion trait S

object S extends S

Type Members

Value Members

Inherited from S

Inherited from UserAgentCalculator

Inherited from Loggable

Inherited from HasParams

Inherited from AnyRef

Inherited from Any

Ungrouped