BindParam that binds a given value into a new attribute.
Base class for Bind parameters.
A trait that indicates what the newly bound attribute name should be.
BindParam that computes a new attribute value based on the current attribute value.
BindParam that computes an optional new attribute value based on the current attribute value.
BindParam that computes an optional new attribute value based on the current attribute value.
BindParam using a function to calculate its value
A case class that wraps attribute-oriented BindParams to allow prefixing the resulting attribute
Constant BindParam always returning the same value
Constant BindParam always returning the same value
This class creates a BindParam from an input value
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
coersable 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 occured.) You may want to look at the fixedRender method which is
only called once and sets up a stable rendering state.
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.
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.
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.
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
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.
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.
BindParam that binds a given value into a new attribute.
BindParam using a function to calculate its value.
BindParam that computes an optional new attribute value based on the current attribute value.
BindParam that computes an optional new attribute value based on the current attribute value.
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
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
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
Prepends the handler to the Json Handlers.
Prepends the handler to the Json Handlers. Should only be used during instantiation
-- the PartialFunction that can handle a JSON request
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
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
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.
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.
Set this method to true to have the Json call code included in the Comet output
A helper for binding which uses the defaultHtml property and the default prefix.
A helper for binding which uses the defaultHtml property.
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
)
map of name/nodes to replace
nodes containing lift:bind nodes
the NodeSeq that results from the specified transforms
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
the namespace of tags to bind
a box containing the function to use as the default transform for tags in the specified namespace that do not have bindings specified.
a box containing the function to use as the default transform for unrecognized attributes in bound elements.
the NodeSeq in which to find elements to be bound.
the list of BindParam bindings to be applied
the NodeSeq that results from the specified transforms
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
the namespace of tags to bind
a box containing the function to use as the default transform for tags in the specified namespace that do not have bindings specified.
a box containing the function to use as the default transform for unrecognized attributes in bound elements.
the NodeSeq in which to find elements to be bound.
the list of BindParam bindings to be applied
the NodeSeq that results from the specified transforms
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
= =
the namespace of tags to bind
the NodeSeq in which to find elements to be bound.
the list of BindParam bindings to be applied
the NodeSeq that results from the specified transforms
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)
the NodeSeq that results from the specified transforms
Creates the span element acting as the real estate for commet rendering.
Creates the span element acting as the real estate for commet rendering.
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 convertion of something to a RenderOut, override this method if you want to cache fixedRender
Calculate fixedRender and capture the postpage javascript
Calculate fixedRender and capture the postpage javascript
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.
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.
the prefix (e.g., "choose")
the tag to choose (e.g., "stuff")
the node sequence to search for the specified element
the first matching node sequence
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
The locale for the session that created the CometActor
The locale for the session that created the CometActor
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.
Compose the Message Handler function.
Compose the Message Handler function. By default, composes highPriority orElse mediumePriority 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
promote a String to a ToCssBindPromotor
promote a String to a ToCssBindPromotor
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
The template that was passed to this component during comet initializations
Set to 'true' if we should run "render" on every page load
Set to 'true' if we should run "render" on every page load
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.
Ensure that the first Element has the specified ID
Ensure that the first Element has the specified ID
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
Similar with S.
Similar with S.error
Similar with S.
Similar with S.error
Similar with S.
Similar with S.error
Similar with S.
Similar with S.error
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
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
Given an id value, find the Elem with the specified id
Given an id value, find the Elem with the specified id
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.
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
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
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.
Handle messages sent to this Actor before the
It's seriously suboptimal to override this method.
It's seriously suboptimal to override this method. Instead use localSetup()
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'
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'
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>
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.
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.
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.
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.
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.
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
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.
where to put the attributes
where to take the attributes from
'out' element with attributes from 'in'
The optional name of this CometActors
The optional name of this CometActors
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
Similar with S.
Similar with S.notice
Similar with S.
Similar with S.notice
Similar with S.
Similar with S.notice
Similar with S.
Similar with S.notice
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 Seletor Transforms to define rendering.
If there's actor-specific JSON behavior on failure to make the JSON call, include the JavaScript here.
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
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.
If the predicate cell changes, the Dependent will be notified
If the predicate cell changes, the Dependent will be notified
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.
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.
-- Should the fixed part of the CometActor be rendered.
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 prefered mechanism. If you use the jsonSend call, you will get a JObject(JField("command", cmd), JField("param", params))
Replace the element with the id that matches with the replacement nodeseq.
Replace the element with the id that matches with the replacement nodeseq.
The Actor should call this method with a reply to the message
The Actor should call this method with a reply to the message
Is the CometActor running?
Is the CometActor running?
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 !.
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
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 !?.
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 !?.
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.
promote a String to a ToCssBindPromotor
promote a String to a ToCssBindPromotor
Remove all the <head> tags, just leaving the child tags
Remove all the <head> tags, just leaving the child tags
Find three of many templates from the children
Find three of many templates from the children
Find two of many templates from the children
Find two of many templates from the children
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.
The optional type of this CometActor
The optional type of this CometActor
Remove from all dependencies
Remove from all dependencies
Similar with S.
Similar with S.warning
Similar with S.
Similar with S.warning
Similar with S.
Similar with S.warning
Similar with S.
Similar with S.warning
Get a list of all the cells this Dependency depends on
Get a list of all the cells this Dependency depends on
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.
a Full Box containing the value of the attribute if found; Empty otherwise
The Cell notifies the Dependent of the dependency
The Cell notifies the Dependent of the dependency
The Cell notifies the Dependent of the removed dependency
The Cell notifies the Dependent of the removed dependency
transforms a Box into a Text node
Use defaultHtml
Bind parameters to XML.
Bind parameters to XML.
XML with lift:bind elements
data to bind
use the bind function instead
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"
use -> instead
transforms a Symbol to a BindParamAssoc object which can be associated to a BindParam object using the --> operator.
transforms a Symbol to a BindParamAssoc object which can be associated to a BindParam object using the --> operator.
Usage: 'David --> "name"
use -> instead
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.
use bind instead
Takes care of the plumbing for building Comet-based Web Apps