net.liftweb.http

CometActorJ

abstract class CometActorJ extends LiftActorJ with CometActor

Subclass from this class if you're in Java-land and want a CometActor

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. CometActorJ
  2. CometActor
  3. BindHelpers
  4. LiftCometActor
  5. Dependent
  6. LiftActorJ
  7. LiftActor
  8. ForwardableActor
  9. GenericActor
  10. TypedActor
  11. SpecializedLiftActor
  12. SimpleActor
  13. JavaActorBase
  14. AnyRef
  15. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CometActorJ()

Type Members

  1. final class AttrBindParam extends BindParam with BindWithAttr

    BindParam that binds a given value into a new attribute.

  2. sealed trait BindParam extends AnyRef

    Base class for Bind parameters.

  3. trait BindWithAttr extends AnyRef

    A trait that indicates what the newly bound attribute name should be.

  4. final class BooleanBindParam extends (String, Boolean) with BindParam

  5. final class BoxBindParam extends (String, Box[NodeSeq]) with BindParam

  6. final class FuncAttrBindParam extends BindParam with BindWithAttr

    BindParam that computes a new attribute value based on the current attribute value.

  7. final class FuncAttrBoxBindParam extends BindParam with BindWithAttr

    BindParam that computes an optional new attribute value based on the current attribute value.

  8. final class FuncAttrOptionBindParam extends BindParam with BindWithAttr

    BindParam that computes an optional new attribute value based on the current attribute value.

  9. final class FuncBindParam extends (String, (NodeSeq) ⇒ NodeSeq) with BindParam

    BindParam using a function to calculate its value

  10. final class IntBindParam extends (String, Int) with BindParam

  11. final class LongBindParam extends (String, Long) with BindParam

  12. final class OptionBindParam extends (String, Option[NodeSeq]) with BindParam

  13. sealed case class PrefixedBindWithAttr(prefix: String, binding: BindParam with BindWithAttr) extends BindParam with BindWithAttr with Product with Serializable

    A case class that wraps attribute-oriented BindParams to allow prefixing the resulting attribute

  14. class SuperArrowAssoc extends AnyRef

  15. final class SymbolBindParam extends (String, Symbol) with BindParam

  16. final class TheBindParam extends (String, NodeSeq) with BindParam

    Constant BindParam always returning the same value

  17. final class TheBindableBindParam[T <: Bindable] extends (String, T) with BindParam

  18. final class TheStrBindParam extends (String, String) with BindParam

    Constant BindParam always returning the same value

  19. class BindParamAssoc extends AnyRef

    This class creates a BindParam from an input value

Abstract Value Members

  1. abstract def render: RenderOut

    It's the main method to override, to define what is rendered by the CometActor

    It's the main method to override, to define what is rendered by the CometActor

    There are implicit conversions for a bunch of stuff to RenderOut (including NodeSeq). Thus, if you don't declare the return turn to be something other than RenderOut and return something that's coercible into RenderOut, the compiler "does the right thing"(tm) for you.
    There are implicit conversions for NodeSeq, so you can return a pile of XML right here. There's an implicit conversion for NodeSeq => NodeSeq, so you can return a function (e.g., a CssBindFunc) that will convert the defaultHtml to the correct output. There's an implicit conversion from JsCmd, so you can return a pile of JavaScript that'll be shipped to the browser.
    Note that the render method will be called each time a new browser tab is opened to the comet component or the comet component is otherwise accessed during a full page load (this is true if a partialUpdate has occurred.) You may want to look at the fixedRender method which is only called once and sets up a stable rendering state.

    Definition Classes
    CometActor

Concrete Value Members

  1. def !(msg: Any): Unit

    Send a message to the Actor.

    Send a message to the Actor. This call will always succeed and return almost immediately. The message will be processed asynchronously.

    Definition Classes
    SpecializedLiftActorSimpleActor
  2. def !!(msg: Any): Box[Any]

    Send a message to the Actor and wait for the actor to process the message and reply.

    Send a message to the Actor and wait for the actor to process the message and reply.

    Definition Classes
    LiftActorTypedActor
  3. def !!(msg: Any, timeout: Long): Box[Any]

    Send a message to the Actor and wait for up to timeout milliseconds for the actor to process the message and reply.

    Send a message to the Actor and wait for up to timeout milliseconds for the actor to process the message and reply.

    Definition Classes
    LiftActorTypedActor
  4. def !<(msg: Any): LAFuture[Any]

    Send a message to the Actor and get an LAFuture that will contain the reply (if any) from the message

    Send a message to the Actor and get an LAFuture that will contain the reply (if any) from the message

    Definition Classes
    LiftActor
  5. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  6. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  7. def !?(timeout: Long, message: Any): Box[Any]

    Send a message to the Actor and wait for up to timeout milliseconds for the actor to process the message and reply.

    Send a message to the Actor and wait for up to timeout milliseconds for the actor to process the message and reply.

    Definition Classes
    LiftActorTypedActor
  8. def !?(msg: Any): Any

    Send a message to the Actor and wait for the actor to process the message and reply.

    Send a message to the Actor and wait for the actor to process the message and reply.

    Definition Classes
    LiftActorTypedActor
  9. final def ##(): Int

    Definition Classes
    AnyRef → Any
  10. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  11. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  12. object AttrBindParam extends AnyRef

    BindParam that binds a given value into a new attribute.

  13. object BooleanBindParam extends Serializable

  14. object BoxBindParam extends Serializable

  15. object FuncAttrBindParam extends AnyRef

    BindParam using a function to calculate its value.

  16. object FuncAttrBoxBindParam extends AnyRef

    BindParam that computes an optional new attribute value based on the current attribute value.

  17. object FuncAttrOptionBindParam extends AnyRef

    BindParam that computes an optional new attribute value based on the current attribute value.

  18. object FuncBindParam extends Serializable

  19. object IntBindParam extends Serializable

  20. object LongBindParam extends Serializable

  21. object OptionBindParam extends Serializable

  22. object SymbolBindParam extends Serializable

  23. object TheBindParam extends Serializable

  24. object TheBindableBindParam extends Serializable

  25. object TheStrBindParam extends Serializable

  26. lazy val _messageHandler: PartialFunction[Any, Unit]

    Attributes
    protected
    Definition Classes
    LiftActorJ
  27. def addAttributes(in: NodeSeq, attributes: MetaData): NodeSeq

    takes a NodeSeq and applies all the attributes to all the Elems at the top level of the NodeSeq.

    takes a NodeSeq and applies all the attributes to all the Elems at the top level of the NodeSeq. The id attribute is applied to the first-found Elem only

    Definition Classes
    BindHelpers
  28. def addCssClass(cssClass: String, elem: Elem): Elem

    Adds a css class to the existing class tag of an Elem or create the class attribute

    Adds a css class to the existing class tag of an Elem or create the class attribute

    Definition Classes
    BindHelpers
  29. def addCssClass(cssClass: Box[String], elem: Elem): Elem

    Adds a css class to the existing class tag of an Elem or create the class attribute

    Adds a css class to the existing class tag of an Elem or create the class attribute

    Definition Classes
    BindHelpers
  30. def answer(answer: Any): Unit

    Attributes
    protected
    Definition Classes
    CometActor
  31. def appendJsonHandler(h: PartialFunction[Any, JsCmd]): Unit

    Prepends the handler to the Json Handlers.

    Prepends the handler to the Json Handlers. Should only be used during instantiation

    h

    -- the PartialFunction that can handle a JSON request

    Definition Classes
    CometActor
  32. def around[R](f: ⇒ R): R

    You can wrap calls around the evaluation of the mailbox.

    You can wrap calls around the evaluation of the mailbox. This allows you to set up the environment.

    Attributes
    protected
    Definition Classes
    SpecializedLiftActor
  33. def aroundLoans: List[CommonLoanWrapper]

    A list of LoanWrappers that will be executed around the evaluation of mailboxes

    A list of LoanWrappers that will be executed around the evaluation of mailboxes

    Attributes
    protected
    Definition Classes
    SpecializedLiftActor
  34. implicit def arrayToRenderOut(in: Seq[Node]): RenderOut

    Convert a Seq[Node] (the superclass of NodeSeq) to a RenderOut.

    Convert a Seq[Node] (the superclass of NodeSeq) to a RenderOut. The render method returns a RenderOut. This method implicitly (in Scala) or explicitly (in Java) will convert a NodeSeq to a RenderOut. This is helpful if you return a NodeSeq from your render method.

    Attributes
    protected
    Definition Classes
    CometActor
  35. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  36. def ask(who: LiftCometActor, what: Any)(answerWith: (Any) ⇒ Unit): Unit

    Ask another CometActor a question.

    Ask another CometActor a question. That other CometActor will take over the screen real estate until the question is answered.

    Attributes
    protected
    Definition Classes
    CometActor
  37. def attributes: Map[String, String]

    Definition Classes
    CometActor
  38. def autoIncludeJsonCode: Boolean

    Set this method to true to have the Json call code included in the Comet output

    Set this method to true to have the Json call code included in the Comet output

    Definition Classes
    CometActor
  39. def bind(vals: BindParam*): NodeSeq

    A helper for binding which uses the defaultHtml property and the default prefix.

    A helper for binding which uses the defaultHtml property and the default prefix.

    Definition Classes
    CometActor
  40. def bind(prefix: String, vals: BindParam*): NodeSeq

    A helper for binding which uses the defaultHtml property.

    A helper for binding which uses the defaultHtml property.

    Definition Classes
    CometActor
  41. def bind(vals: Map[String, NodeSeq], xml: NodeSeq): NodeSeq

    Replace the content of lift:bind nodes with the corresponding nodes found in a map, according to the value of the "name" attribute.

    Replace the content of lift:bind nodes with the corresponding nodes found in a map, according to the value of the "name" attribute.

    Usage:

      bind(Map("a" ->

    ), change this) must

    )

    vals

    map of name/nodes to replace

    xml

    nodes containing lift:bind nodes

    returns

    the NodeSeq that results from the specified transforms

    Definition Classes
    BindHelpers
  42. def bind(namespace: String, nodeFailureXform: Box[(NodeSeq) ⇒ NodeSeq], paramFailureXform: Box[(PrefixedAttribute) ⇒ MetaData], preserveScope: Boolean, xml: NodeSeq, params: BindParam*): NodeSeq

    Bind a set of values to parameters and attributes in a block of XML with defined transforms for unbound elements within the specified namespace.

    Bind a set of values to parameters and attributes in a block of XML with defined transforms for unbound elements within the specified namespace.

    For example:

      bind("user",
           Full(xhtml: NodeSeq => Text("Default Value")),
           Empty,
           <user:hello>replace this</user:hello><user:dflt>replace with default</user:dflt>,
           "hello" ->

    )

    will return
    =  =
    Default Value
    
    namespace

    the namespace of tags to bind

    nodeFailureXform

    a box containing the function to use as the default transform for tags in the specified namespace that do not have bindings specified.

    paramFailureXform

    a box containing the function to use as the default transform for unrecognized attributes in bound elements.

    xml

    the NodeSeq in which to find elements to be bound.

    params

    the list of BindParam bindings to be applied

    returns

    the NodeSeq that results from the specified transforms

    Definition Classes
    BindHelpers
  43. def bind(namespace: String, nodeFailureXform: Box[(NodeSeq) ⇒ NodeSeq], paramFailureXform: Box[(PrefixedAttribute) ⇒ MetaData], xml: NodeSeq, params: BindParam*): NodeSeq

    Bind a set of values to parameters and attributes in a block of XML with defined transforms for unbound elements within the specified namespace.

    Bind a set of values to parameters and attributes in a block of XML with defined transforms for unbound elements within the specified namespace.

    For example:

      bind("user",
           Full(xhtml: NodeSeq => Text("Default Value")),
           Empty,
           <user:hello>replace this</user:hello><user:dflt>replace with default</user:dflt>,
           "hello" ->

    )

    will return
    =  =
    Default Value
    
    namespace

    the namespace of tags to bind

    nodeFailureXform

    a box containing the function to use as the default transform for tags in the specified namespace that do not have bindings specified.

    paramFailureXform

    a box containing the function to use as the default transform for unrecognized attributes in bound elements.

    xml

    the NodeSeq in which to find elements to be bound.

    params

    the list of BindParam bindings to be applied

    returns

    the NodeSeq that results from the specified transforms

    Definition Classes
    BindHelpers
  44. def bind(namespace: String, xml: NodeSeq, params: BindParam*): NodeSeq

    Bind a set of values to parameters and attributes in a block of XML.

    Bind a set of values to parameters and attributes in a block of XML.

    For example:

      bind("user", <user:hello>replace this</user:hello>, "hello" ->

    )

    will return
    =  =
    
    namespace

    the namespace of tags to bind

    xml

    the NodeSeq in which to find elements to be bound.

    params

    the list of BindParam bindings to be applied

    returns

    the NodeSeq that results from the specified transforms

    Definition Classes
    BindHelpers
  45. def bindlist(listvals: List[Map[String, NodeSeq]], xml: NodeSeq): Box[NodeSeq]

    Bind a list of name/xml maps to a block of XML containing lift:bind nodes (see the bind(Map, NodeSeq) function)

    Bind a list of name/xml maps to a block of XML containing lift:bind nodes (see the bind(Map, NodeSeq) function)

    returns

    the NodeSeq that results from the specified transforms

    Definition Classes
    BindHelpers
  46. def buildSpan(time: Long, xml: NodeSeq): NodeSeq

    Creates the span element acting as the real estate for comet rendering.

    Creates the span element acting as the real estate for comet rendering.

    Definition Classes
    CometActorLiftCometActor
  47. def cacheFixedRender: Boolean

    By default, we do not cache the value of fixedRender.

    By default, we do not cache the value of fixedRender. If it's expensive to recompute it each time there's a conversion of something to a RenderOut, override this method if you want to cache fixedRender.

    Attributes
    protected
    Definition Classes
    CometActor
  48. def calcFixedRender: Box[NodeSeq]

    Calculate fixedRender and capture the postpage javascript

    Calculate fixedRender and capture the postpage javascript

    Attributes
    protected
    Definition Classes
    CometActor
  49. def calculateJavaMessageHandler: PartialFunction[Any, Unit]

    Attributes
    protected
    Definition Classes
    LiftActorJ
  50. def captureInitialReq(initialReq: Box[Req]): Unit

    Comet Actors live outside the HTTP request/response cycle.

    Comet Actors live outside the HTTP request/response cycle. However, it may be useful to know what Request led to the creation of the CometActor. You can override this method and capture the initial Req object. Note that keeping a reference to the Req may lead to memory retention issues if the Req contains large message bodies, etc. It's optimal to capture the path or capture any request parameters that you care about rather the keeping the whole Req reference.

    Attributes
    protected
    Definition Classes
    CometActor
  51. def chooseTemplate(prefix: String, tag: String, xhtml: NodeSeq): NodeSeq

    Finds and returns one of many templates from the children based upon the namespace and tag name: for example, for prefix "choose" and tag name "stuff" this would return the contents of the first tag <choose:stuff> ... </choose:stuff> in the specified NodeSeq.

    Finds and returns one of many templates from the children based upon the namespace and tag name: for example, for prefix "choose" and tag name "stuff" this would return the contents of the first tag <choose:stuff> ... </choose:stuff> in the specified NodeSeq.

    prefix

    the prefix (e.g., "choose")

    tag

    the tag to choose (e.g., "stuff")

    xhtml

    the node sequence to search for the specified element

    returns

    the first matching node sequence

    Definition Classes
    BindHelpers
  52. def clearWiringDependencies(): Unit

    Clear the common dependencies for Wiring.

    Clear the common dependencies for Wiring. This method will clearPostPageJavaScriptForThisPage() and unregisterFromAllDependencies(). The combination will result in a clean slate for Wiring during a redraw. You can change the behavior of the wiring dependency management by overriding this method

    Attributes
    protected
    Definition Classes
    CometActor
  53. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  54. def cometActorLocale: Locale

    The locale for the session that created the CometActor

    The locale for the session that created the CometActor

    Definition Classes
    LiftCometActor
  55. def cometListeners: List[ListenerId]

    Return the list of ListenerIds of all long poll agents that are waiting for this CometActor to change its state.

    Return the list of ListenerIds of all long poll agents that are waiting for this CometActor to change its state. This method is useful for detecting presence.

    Attributes
    protected
    Definition Classes
    CometActor
  56. def cometProcessingTimeout: Long

    Override in sub-class to customise timeout for AJAX-requests to the comet-component for the specific comet

    Override in sub-class to customise timeout for AJAX-requests to the comet-component for the specific comet

    Definition Classes
    LiftCometActor
  57. def cometProcessingTimeoutHandler(): JsCmd

    This is to react to comet-requests timing out.

    This is to react to comet-requests timing out. When the timeout specified in LiftRules#cometProcessingTimeout occurs one may override this to send a message to the user informing of the timeout.

    Do NOT manipulate actor-state here. If you want to manipulate state, send the actor a new message.

    Typical example would be:

      override def cometTimeoutHandler(): JsCmd = {
        Alert("Timeout processing comet-request, timeout is: " + cometProcessingTimeout + "ms")
    }
    

    Definition Classes
    LiftCometActor
  58. def cometRenderTimeout: Long

    Override in sub-class to customise timeout for the render()-method for the specific comet

    Override in sub-class to customise timeout for the render()-method for the specific comet

    Definition Classes
    LiftCometActor
  59. def cometRenderTimeoutHandler(): Box[NodeSeq]

    This is to react to comet-actors timing out while initial rendering, calls to render().

    This is to react to comet-actors timing out while initial rendering, calls to render(). When the timeout specified in LiftRules#cometRenderTimeout occurs one may override this to customise the output.

    Do NOT manipulate actor-state here. If you want to manipulate state, send the actor a new message.

    Typical example would be:

      override def renderTimeoutHandler(): Box[NodeSeq] = {
        Full(<div>Comet {this.getClass} timed out, timeout is {cometRenderTimeout}ms</div>)
    }
    

    Definition Classes
    LiftCometActor
  60. def composeFunction: PartialFunction[Any, Unit]

    Compose the Message Handler function.

    Compose the Message Handler function. By default, composes highPriority orElse mediumPriority orElse internalHandler orElse lowPriority orElse internalHandler. But you can change how the handler works if doing stuff in highPriority, mediumPriority and lowPriority is not enough.

    Attributes
    protected
    Definition Classes
    CometActor
  61. implicit def cssSelectorToCssBindPromoter(sel: CssSelector): ToCssBindPromoter

    promote a String to a ToCssBindPromotor

    promote a String to a ToCssBindPromotor

    Definition Classes
    BindHelpers
  62. def deepEnsureUniqueId(in: NodeSeq): NodeSeq

    For a list of NodeSeq, ensure that the the id of the root Elems are unique.

    For a list of NodeSeq, ensure that the the id of the root Elems are unique. If there's a duplicate, that Elem will be returned without an id

    Definition Classes
    BindHelpers
  63. def defaultHtml: NodeSeq

    The template that was passed to this component during comet initializations

    The template that was passed to this component during comet initializations

    Definition Classes
    CometActor
  64. def defaultPrefix: Box[String]

    Definition Classes
    CometActor
  65. def devMode: Boolean

    Set to 'true' if we should run "render" on every page load

    Set to 'true' if we should run "render" on every page load

    Attributes
    protected
    Definition Classes
    CometActor
  66. def dontCacheRendering: Boolean

    Set this method to true if you want to avoid caching the rendering.

    Set this method to true if you want to avoid caching the rendering. This trades space for time.

    Attributes
    protected
    Definition Classes
    CometActor
  67. implicit def elemToFull(in: Elem): Box[NodeSeq]

    Definition Classes
    CometActor
  68. def ensureId(ns: NodeSeq, id: String): NodeSeq

    Ensure that the first Element has the specified ID

    Ensure that the first Element has the specified ID

    Definition Classes
    BindHelpers
  69. def ensureUniqueId(in: Seq[NodeSeq]): Seq[NodeSeq]

    For a list of NodeSeq, ensure that the the id of the root Elems are unique.

    For a list of NodeSeq, ensure that the the id of the root Elems are unique. If there's a duplicate, that Elem will be returned without an id

    Definition Classes
    BindHelpers
  70. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  72. def error(id: String, n: String): Unit

    Similar with S.

    Similar with S.error

    Definition Classes
    CometActor
  73. def error(id: String, n: NodeSeq): Unit

    Similar with S.

    Similar with S.error

    Definition Classes
    CometActor
  74. def error(n: NodeSeq): Unit

    Similar with S.

    Similar with S.error

    Definition Classes
    CometActor
  75. def error(n: String): Unit

    Similar with S.

    Similar with S.error

    Definition Classes
    CometActor
  76. def errorDiv(body: NodeSeq): Box[NodeSeq]

    Definition Classes
    BindHelpers
  77. def exceptionHandler: PartialFunction[Throwable, Unit]

    Attributes
    protected
    Definition Classes
    SpecializedLiftActor
  78. def execTranslate(f: (Any) ⇒ Unit)(v: Any): Unit

    Attributes
    protected
    Definition Classes
    LiftActorSpecializedLiftActor
  79. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  80. def findBox[T](nodes: Seq[Node])(f: (Elem) ⇒ Box[T]): Box[T]

    Given a NodeSeq and a function that returns a Box[T], return the first value found in which the function evaluates to Full

    Given a NodeSeq and a function that returns a Box[T], return the first value found in which the function evaluates to Full

    Definition Classes
    BindHelpers
  81. def findId(ns: NodeSeq): Box[String]

    Finds the first Element in the NodeSeq (or any children) that has an ID attribute

    Finds the first Element in the NodeSeq (or any children) that has an ID attribute

    Definition Classes
    BindHelpers
  82. def findId(nodes: Seq[Node], id: String): Option[Elem]

    Given an id value, find the Elem with the specified id

    Given an id value, find the Elem with the specified id

    Definition Classes
    BindHelpers
  83. def findNode(in: Elem, nodes: NodeSeq): Box[Elem]

    Finds and returns the first node in the specified NodeSeq and its children with the same label and prefix as the specified element.

    Finds and returns the first node in the specified NodeSeq and its children with the same label and prefix as the specified element.

    Definition Classes
    BindHelpers
  84. def findOption[T](nodes: Seq[Node])(f: (Elem) ⇒ Option[T]): Option[T]

    Given a NodeSeq and a function that returns an Option[T], return the first value found in which the function evaluates to Some

    Given a NodeSeq and a function that returns an Option[T], return the first value found in which the function evaluates to Some

    Definition Classes
    BindHelpers
  85. def findOrCreateId(f: (String) ⇒ (NodeSeq) ⇒ NodeSeq): (NodeSeq) ⇒ NodeSeq

    Find the first Elem in the NodeSeq.

    Find the first Elem in the NodeSeq. If it has an id attribute, then call the function, f, with that id. If the first Elem does not have an id attribute, create an id attribute and pass that id attribute to the function

    Definition Classes
    BindHelpers
  86. def fixedRender: Box[NodeSeq]

    A part of the CometActor's screen real estate that is not updated by default with reRender().

    A part of the CometActor's screen real estate that is not updated by default with reRender(). This block of HTML is useful for the editor part of a Comet-based control where the data is JSON and updated with partialUpdates.

    Definition Classes
    CometActor
  87. final def forwardMessageTo(msg: Any, forwardTo: TypedActor[Any, Any]): Unit

    Attributes
    protected
    Definition Classes
    LiftActorForwardableActor
  88. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any
  89. def handleJson(in: Any): JsCmd

    Definition Classes
    CometActor
  90. def hasOuter: Boolean

    Definition Classes
    CometActorLiftCometActor
  91. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  92. def highPriority: PartialFunction[Any, Unit]

    Handle messages sent to this Actor before the

    Handle messages sent to this Actor before the

    Definition Classes
    CometActor
  93. def highPriorityReceive: Box[PartialFunction[Any, Unit]]

    Attributes
    protected
    Definition Classes
    SpecializedLiftActor
  94. def initCometActor(theSession: LiftSession, theType: Box[String], name: Box[String], defaultHtml: NodeSeq, attributes: Map[String, String]): Unit

    It's seriously suboptimal to override this method.

    It's seriously suboptimal to override this method. Instead use localSetup()

    Attributes
    protected
    Definition Classes
    CometActorLiftCometActor
  95. def insertMsgAtHeadOfQueue_!(msg: Any): Unit

    This method inserts the message at the head of the mailbox.

    This method inserts the message at the head of the mailbox. It's protected because this functionality may or may not want to be exposed.

    Attributes
    protected
    Definition Classes
    SpecializedLiftActor
  96. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  97. implicit def jsToXmlOrJsCmd(in: JsCmd): RenderOut

    Attributes
    protected
    Definition Classes
    CometActor
  98. lazy val jsonCall: JsonCall

    Definition Classes
    CometActorLiftCometActor
  99. lazy val jsonInCode: JsCmd

    Definition Classes
    CometActor
  100. def jsonSend: JsonCall

    The JavaScript call that you use to send the data to the server.

    The JavaScript call that you use to send the data to the server. For example: <button onclick={jsonSend("Hello", JsRaw("Dude".encJs))}>Click</button>

    Definition Classes
    CometActor
  101. def jsonToIncludeInCode: JsCmd

    The call that packages up the JSON and tosses it to the server.

    The call that packages up the JSON and tosses it to the server. If you set autoIncludeJsonCode to true, then this will be included in the stuff sent to the server.

    Definition Classes
    CometActor
  102. def lifespan: Box[TimeSpan]

    The lifespan of this component.

    The lifespan of this component. By default CometActors will last for the entire session that they were created in, even if the CometActor is not currently visible. You can set the lifespan of the CometActor. If the CometActor isn't visible on any page for some period after its lifespan the CometActor will be shut down.

    Definition Classes
    CometActor
  103. def listenerTransition(): Unit

    This method will be called when there's a change in the long poll listeners.

    This method will be called when there's a change in the long poll listeners. The method does nothing, but allows you to get a granular sense of how many browsers care about this CometActor. Note that this method should not block for any material time and if there's any processing to do, use Scheduler.schedule or send a message to this CometActor. Do not change the Actor's state from this method.

    Attributes
    protected
    Definition Classes
    CometActor
  104. def localSetup(): Unit

    This method will be called after the Actor has started.

    This method will be called after the Actor has started. Do any setup here. DO NOT do initialization in the constructor or in initCometActor... do it here.

    Attributes
    protected
    Definition Classes
    CometActor
  105. def localShutdown(): Unit

    This method will be called as part of the shut-down of the actor.

    This method will be called as part of the shut-down of the actor. Release any resources here.

    Attributes
    protected
    Definition Classes
    CometActor
  106. def lowPriority: PartialFunction[Any, Unit]

    Definition Classes
    CometActorJCometActor
  107. def manualWiringDependencyManagement: Boolean

    By default, Lift deals with managing wiring dependencies.

    By default, Lift deals with managing wiring dependencies. This means on each full render (a full render will happen on reRender() or on a page load if there have been partial updates.) You may want to manually deal with wiring dependencies. If you do, override this method and return true

    Attributes
    protected
    Definition Classes
    CometActor
  108. def mediumPriority: PartialFunction[Any, Unit]

    Definition Classes
    CometActor
  109. def messageHandler: PartialFunction[Any, Unit]

    Attributes
    protected
    Definition Classes
    CometActorSpecializedLiftActor
  110. def mixinAttributes(out: Elem)(in: NodeSeq): NodeSeq

    Takes attributes from the first node of 'in' (if any) and mixes them into 'out'.

    Takes attributes from the first node of 'in' (if any) and mixes them into 'out'. Curried form can be used to produce a NodeSeq => NodeSeq for bind.

    out

    where to put the attributes

    in

    where to take the attributes from

    returns

    'out' element with attributes from 'in'

    Definition Classes
    BindHelpers
  111. def name: Box[String]

    The optional name of this CometActors

    The optional name of this CometActors

    Definition Classes
    CometActorLiftCometActor
  112. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  113. implicit def nodeSeqFuncToBoxNodeSeq(f: (NodeSeq) ⇒ NodeSeq): Box[NodeSeq]

    A helpful implicit conversion that takes a NodeSeq => NodeSeq (for example a CssSel) and converts it to a Box[NodeSeq] by applying the function to defaultHtml

    A helpful implicit conversion that takes a NodeSeq => NodeSeq (for example a CssSel) and converts it to a Box[NodeSeq] by applying the function to defaultHtml

    Attributes
    protected
    Definition Classes
    CometActor
  114. implicit def nodeSeqToFull(in: NodeSeq): Box[NodeSeq]

    Definition Classes
    CometActor
  115. def notice(id: String, n: String): Unit

    Similar with S.

    Similar with S.notice

    Definition Classes
    CometActor
  116. def notice(id: String, n: NodeSeq): Unit

    Similar with S.

    Similar with S.notice

    Definition Classes
    CometActor
  117. def notice(n: NodeSeq): Unit

    Similar with S.

    Similar with S.notice

    Definition Classes
    CometActor
  118. def notice(n: String): Unit

    Similar with S.

    Similar with S.notice

    Definition Classes
    CometActor
  119. final def notify(): Unit

    Definition Classes
    AnyRef
  120. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  121. implicit def nsToNsFuncToRenderOut(f: (NodeSeq) ⇒ NodeSeq): RenderOut

    Convert a NodeSeq => NodeSeq to a RenderOut.

    Convert a NodeSeq => NodeSeq to a RenderOut. The render method returns a RenderOut. This method implicitly (in Scala) or explicitly (in Java) will convert a NodeSeq => NodeSeq to a RenderOut. This is helpful if you use Lift's CSS Selector Transforms to define rendering.

    Attributes
    protected
    Definition Classes
    CometActor
  122. def onJsonError: Box[JsCmd]

    If there's actor-specific JSON behavior on failure to make the JSON call, include the JavaScript here.

    If there's actor-specific JSON behavior on failure to make the JSON call, include the JavaScript here.

    Definition Classes
    CometActor
  123. implicit def pairToPair(in: (String, Any)): (String, NodeSeq)

    Definition Classes
    CometActor
  124. def parentTag: Elem

    Definition Classes
    CometActorLiftCometActor
  125. def partialUpdate(cmd: ⇒ JsCmd): Unit

    Perform a partial update of the comet component based on the JsCmd.

    Perform a partial update of the comet component based on the JsCmd. This means that the JsCmd will be sent to all of the currently listening browser tabs. This is the preferred method over reRender to update the component

    Attributes
    protected
    Definition Classes
    CometActor
  126. def poke(): Unit

    Poke the CometActor and cause it to do a partial update Noop which will have the effect of causing the component to redisplay any Wiring elements on the component.

    Poke the CometActor and cause it to do a partial update Noop which will have the effect of causing the component to redisplay any Wiring elements on the component. This method is Actor-safe and may be called from any thread, not just the Actor's message handler thread.

    Definition Classes
    CometActorLiftCometActor
  127. def predicateChanged(which: net.liftweb.util.Cell[_]): Unit

    If the predicate cell changes, the Dependent will be notified

    If the predicate cell changes, the Dependent will be notified

    Definition Classes
    LiftCometActorDependent
  128. def reRender(): Unit

    Cause the entire component to be reRendered and pushed out to any listeners.

    Cause the entire component to be reRendered and pushed out to any listeners. This method will cause the entire component to be rendered which can result in a huge blob of JavaScript to be sent to the client. It's a much better practice to use partialUpdate for non-trivial CometActor components.

    Definition Classes
    CometActor
  129. def reRender(sendAll: Boolean): Unit

    Cause the entire component to be reRendered and pushed out to any listeners.

    Cause the entire component to be reRendered and pushed out to any listeners. This method will cause the entire component to be rendered which can result in a huge blob of JavaScript to be sent to the client. It's a much better practice to use partialUpdate for non-trivial CometActor components.

    sendAll

    -- Should the fixed part of the CometActor be rendered.

    Definition Classes
    CometActor
  130. def receiveJson: PartialFunction[JValue, JsCmd]

    Override this method to deal with JSON sent from the browser via the sendJson function.

    Override this method to deal with JSON sent from the browser via the sendJson function. This is based on the Lift JSON package rather than the handleJson stuff based on the older util.JsonParser. This is the preferred mechanism. If you use the jsonSend call, you will get a JObject(JField("command", cmd), JField("param", params))

    Definition Classes
    CometActor
  131. def replaceIdNode(in: NodeSeq, id: String, replacement: NodeSeq): NodeSeq

    Replace the element with the id that matches with the replacement nodeseq.

    Replace the element with the id that matches with the replacement nodeseq.

    Definition Classes
    BindHelpers
  132. def reply(v: Any): Unit

    The Actor should call this method with a reply to the message

    The Actor should call this method with a reply to the message

    Attributes
    protected
    Definition Classes
    LiftActorForwardableActor
  133. def reportError(msg: String, exception: Exception): Unit

    How to report an error that occurs during message dispatch

    How to report an error that occurs during message dispatch

    Attributes
    protected
    Definition Classes
    CometActor
  134. def running: Boolean

    Is the CometActor running?

    Is the CometActor running?

    Attributes
    protected
    Definition Classes
    CometActor
  135. def send(msg: Any): Unit

    Send a message to the Actor.

    Send a message to the Actor. This call will always succeed and return almost immediately. The message will be processed asynchronously. This is a Java-callable alias for !.

    Definition Classes
    SpecializedLiftActor
  136. def sendAndGetFuture(msg: Any): LAFuture[Any]

    Send a message to the Actor and get an LAFuture that will contain the reply (if any) from the message.

    Send a message to the Actor and get an LAFuture that will contain the reply (if any) from the message. This method calls !< and is here for Java compatibility.

    Definition Classes
    LiftActor
  137. def sendAndGetReply(timeout: Long, msg: Any): Any

    Send a message to the Actor and wait for up to timeout milliseconds for the actor to process the message and reply.

    Send a message to the Actor and wait for up to timeout milliseconds for the actor to process the message and reply. This method is the Java callable version of !?.

    Definition Classes
    LiftActor
  138. def sendAndGetReply(msg: Any): Any

    Send a message to the Actor and wait for the actor to process the message and reply.

    Send a message to the Actor and wait for the actor to process the message and reply. This method is the Java callable version of !?.

    Definition Classes
    LiftActor
  139. def sendInitialReq_?: Boolean

    Is this CometActor going to capture the initial Req object? If yes, override this method and return true and override captureInitialReq to capture the Req.

    Is this CometActor going to capture the initial Req object? If yes, override this method and return true and override captureInitialReq to capture the Req. Why have to explicitly ask for the Req? In order to send Req instances across threads, the Req objects must be snapshotted which is the process of reading the POST or PUT body from the HTTP request stream. We don't want to do this unless we have to, so by default the Req is not snapshotted/sent. But if you want it, you can have it.

    Definition Classes
    LiftCometActor
  140. def startQuestion(what: Any): Unit

    Attributes
    protected
    Definition Classes
    CometActor
  141. implicit def strToCssBindPromoter(str: String): ToCssBindPromoter

    promote a String to a ToCssBindPromotor

    promote a String to a ToCssBindPromotor

    Definition Classes
    BindHelpers
  142. implicit def strToSuperArrowAssoc(in: String): SuperArrowAssoc

    Definition Classes
    BindHelpers
  143. def stripHead(in: NodeSeq): NodeSeq

    Remove all the <head> tags, just leaving the child tags

    Remove all the <head> tags, just leaving the child tags

    Definition Classes
    BindHelpers
  144. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  145. def template(xhtml: NodeSeq, prefix: String, tag1: String, tag2: String, tag3: String): Box[(NodeSeq, NodeSeq, NodeSeq)]

    Find three of many templates from the children

    Find three of many templates from the children

    Definition Classes
    BindHelpers
  146. def template(xhtml: NodeSeq, prefix: String, tag1: String, tag2: String): Box[(NodeSeq, NodeSeq)]

    Find two of many templates from the children

    Find two of many templates from the children

    Definition Classes
    BindHelpers
  147. def template(xhtml: NodeSeq, prefix: String, tag: String): Box[NodeSeq]

    Similar to chooseTemplate, this returns the contents of the element in a Full Box if found or an Empty Box otherwise.

    Similar to chooseTemplate, this returns the contents of the element in a Full Box if found or an Empty Box otherwise.

    Definition Classes
    BindHelpers
  148. def testTranslate(f: (Any) ⇒ Boolean)(v: Any): Boolean

    Attributes
    protected
    Definition Classes
    LiftActorSpecializedLiftActor
  149. def theSession: LiftSession

    Definition Classes
    CometActor
  150. def theType: Box[String]

    The optional type of this CometActor

    The optional type of this CometActor

    Definition Classes
    CometActorLiftCometActor
  151. def toString(): String

    Definition Classes
    AnyRef → Any
  152. def unWatch: Unit

    Definition Classes
    CometActor
  153. val uniqueId: String

    Definition Classes
    CometActorLiftCometActor
  154. def unregisterFromAllDependencies(): Unit

    Remove from all dependencies

    Remove from all dependencies

    Attributes
    protected
    Definition Classes
    Dependent
  155. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  156. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  157. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  158. def warning(id: String, n: String): Unit

    Similar with S.

    Similar with S.warning

    Definition Classes
    CometActor
  159. def warning(id: String, n: NodeSeq): Unit

    Similar with S.

    Similar with S.warning

    Definition Classes
    CometActor
  160. def warning(n: NodeSeq): Unit

    Similar with S.

    Similar with S.warning

    Definition Classes
    CometActor
  161. def warning(n: String): Unit

    Similar with S.

    Similar with S.warning

    Definition Classes
    CometActor
  162. def whoDoIDependOn: Seq[net.liftweb.util.Cell[_]]

    Get a list of all the cells this Dependency depends on

    Get a list of all the cells this Dependency depends on

    Attributes
    protected
    Definition Classes
    Dependent
  163. def xmlParam(in: NodeSeq, param: String): Box[String]

    Finds the named attribute in specified XML element and returns a Full Box containing the value of the attribute if found.

    Finds the named attribute in specified XML element and returns a Full Box containing the value of the attribute if found. Empty otherwise.

    returns

    a Full Box containing the value of the attribute if found; Empty otherwise

    Definition Classes
    BindHelpers
  164. def youDependOnMe(who: net.liftweb.util.Cell[_]): Unit

    The Cell notifies the Dependent of the dependency

    The Cell notifies the Dependent of the dependency

    Definition Classes
    Dependent
  165. def youDontDependOnMe(who: net.liftweb.util.Cell[_]): Unit

    The Cell notifies the Dependent of the removed dependency

    The Cell notifies the Dependent of the removed dependency

    Definition Classes
    Dependent

Deprecated Value Members

  1. object BindParamAssoc extends AnyRef

    transforms a Box into a Text node

  2. def defaultXml: NodeSeq

    Definition Classes
    CometActor
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3) Use defaultHtml

  3. def processBind(around: NodeSeq, atWhat: Map[String, NodeSeq]): NodeSeq

    Bind parameters to XML.

    Bind parameters to XML.

    around

    XML with lift:bind elements

    atWhat

    data to bind

    Definition Classes
    BindHelpers
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3) use the bind function instead

  4. implicit def strToBPAssoc(in: String): BindParamAssoc

    transforms a String to a BindParamAssoc object which can be associated to a BindParam object using the --> operator.

    transforms a String to a BindParamAssoc object which can be associated to a BindParam object using the --> operator.

    Usage: "David" --> "name"

    Definition Classes
    BindHelpers
    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) use -> instead

  5. implicit def symToSAAssoc(in: Symbol): SuperArrowAssoc

    transforms a Symbol to a SuperArrowAssoc object which can be associated to a BindParam object using the -> operator.

    transforms a Symbol to a SuperArrowAssoc object which can be associated to a BindParam object using the -> operator.

    Usage: 'David -> "name"

    Definition Classes
    BindHelpers
    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) use -> instead

  6. def unregisterFromAllDepenencies(): Unit

    Attributes
    protected
    Definition Classes
    Dependent
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5) please used the correctly spelled unregisterFromAllDependencies

  7. def xbind(namespace: String, xml: NodeSeq)(transform: PartialFunction[String, (NodeSeq) ⇒ NodeSeq]): NodeSeq

    Experimental extension to bind which passes in an additional "parameter" from the XHTML to the transform function, which can be used to format the returned NodeSeq.

    Experimental extension to bind which passes in an additional "parameter" from the XHTML to the transform function, which can be used to format the returned NodeSeq.

    Definition Classes
    BindHelpers
    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) use bind instead

Inherited from CometActor

Inherited from BindHelpers

Inherited from LiftCometActor

Inherited from Dependent

Inherited from LiftActorJ

Inherited from LiftActor

Inherited from ForwardableActor[Any, Any]

Inherited from GenericActor[Any]

Inherited from TypedActor[Any, Any]

Inherited from SpecializedLiftActor[Any]

Inherited from SimpleActor[Any]

Inherited from JavaActorBase

Inherited from AnyRef

Inherited from Any