RealtimeEvent

RealtimeEvent is a configurable JavaScriptContent that can be supplied to any HTMLTag's JavaScript event to cause all events of that type to propagate to the server.

confirmation: optionally confirmation message that should be shown before sending the event
preventDefault: true if the default event should be prevented (defaults to true)
fireChange: if true a change event is fired immediately before this event (defaults to false)
delay: the amount of time to delay before sending the event in seconds (defaults to 0)
maximumRate: the maximum rate to send events in seconds. For example, if 5 seconds is specified then an event will be sent to the server a maximum of every five seconds.

Linear Supertypes

Serializable, Serializable, Product, Equals, JavaScriptContent, XMLContent, Element[Any], Listenable, MutableChildLike[Any], ChildLike[Any], AnyRef, Any

Instance Constructors

new RealtimeEvent(confirmation: Option[String] = None, preventDefault: Boolean = true, fireChange: Boolean = false, delay: Double = 0.0, maximumRate: Double = 0.0)

confirmation
optionally confirmation message that should be shown before sending the event
preventDefault
true if the default event should be prevented (defaults to true)
fireChange
if true a change event is fired immediately before this event (defaults to false)
delay
the amount of time to delay before sending the event in seconds (defaults to 0)
maximumRate
the maximum rate to send events in seconds. For example, if 5 seconds is specified then an event will be sent to the server a maximum of every five seconds.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(js: JavaScriptContent): JavaScriptString

Definition Classes
JavaScriptContent
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

optionally confirmation message that should be shown before sending the event
def connected[Ancestor](f: (Ancestor) ⇒ Unit)(implicit manifest: Manifest[Ancestor]): Unit

Definition Classes
Element
lazy val content: String

Definition Classes
RealtimeEvent → JavaScriptContent
val delay: Double

the amount of time to delay before sending the event in seconds (defaults to 0)
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

if true a change event is fired immediately before this event (defaults to false)
def generate(): String

Definition Classes
JavaScriptContent
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
var hierarchicalParent: Any

Attributes
protected
Definition Classes
MutableChildLike → ChildLike
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def listen[Event, Response, Result](name: String, priority: Priority, modes: ListenMode*)(f: (Event) ⇒ Response)(implicit eventManifest: Manifest[Event]): FunctionalListener[Event, Response]

Definition Classes
Listenable
val listeners: Listeners

Definition Classes
Listenable
val maximumRate: Double

the maximum rate to send events in seconds.
the maximum rate to send events in seconds. For example, if 5 seconds is specified then an event will be sent to the server a maximum of every five seconds.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parent: Any

Definition Classes
Element
def parseJson(map: Map[String, Any]): JavaScriptString

Definition Classes
JavaScriptContent
val preventDefault: Boolean

true if the default event should be prevented (defaults to true)
def read(content: Content): Unit

Definition Classes
JavaScriptContent → XMLContent
def removeFromParent(): Boolean

Definition Classes
XMLContent
def render: Boolean

Definition Classes
XMLContent
def replaceWith[T <: XMLContent](content: T): T

Definition Classes
XMLContent
def root[T](implicit manifest: Manifest[T]): Option[T]

Definition Classes
Element
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
implicit val thisListenable: Listenable

Definition Classes
Listenable
def toString(): String

Definition Classes
JavaScriptContent → AnyRef → Any
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 write(writer: HTMLWriter): Unit

Definition Classes
JavaScriptContent → XMLContent

Related Doc: package realtime

case class RealtimeEvent(confirmation: Option[String] = None, preventDefault: Boolean = true, fireChange: Boolean = false, delay: Double = 0.0, maximumRate: Double = 0.0) extends JavaScriptContent with Product with Serializable

Instance Constructors

new RealtimeEvent(confirmation: Option[String] = None, preventDefault: Boolean = true, fireChange: Boolean = false, delay: Double = 0.0, maximumRate: Double = 0.0)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(js: JavaScriptContent): JavaScriptString

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val confirmation: Option[String]

def connected[Ancestor](f: (Ancestor) ⇒ Unit)(implicit manifest: Manifest[Ancestor]): Unit

lazy val content: String

val delay: Double

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

val fireChange: Boolean

def generate(): String

final def getClass(): Class[_]

var hierarchicalParent: Any

final def isInstanceOf[T0]: Boolean

def listen[Event, Response, Result](name: String, priority: Priority, modes: ListenMode*)(f: (Event) ⇒ Response)(implicit eventManifest: Manifest[Event]): FunctionalListener[Event, Response]

val listeners: Listeners

val maximumRate: Double

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parent: Any

def parseJson(map: Map[String, Any]): JavaScriptString

val preventDefault: Boolean

def read(content: Content): Unit

def removeFromParent(): Boolean

def render: Boolean

def replaceWith[T <: XMLContent](content: T): T

def root[T](implicit manifest: Manifest[T]): Option[T]

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

implicit val thisListenable: Listenable

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def write(writer: HTMLWriter): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from JavaScriptContent

Inherited from XMLContent

Inherited from Element[Any]

Inherited from Listenable

Inherited from MutableChildLike[Any]

Inherited from ChildLike[Any]

Inherited from AnyRef

Inherited from Any

Ungrouped