Circuit

Type Members

type Cursor = (M) ⇒ AnyRef
type HandlerFunction = PartialFunction[AnyRef, ActionResult[M]]
type Listener = () ⇒ Unit

Abstract Value Members

abstract def actionHandler: HandlerFunction

Attributes
protected
abstract val model: M

Attributes
protected

Concrete Value Members

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 addProcessor(processor: ActionProcessor): Unit

Adds a new ActionProcessor to the action processing chain.
Adds a new ActionProcessor to the action processing chain. The processor is called for every dispatched action.
def apply(action: AnyRef): Unit

Definition Classes
Dispatcher
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def combineHandlers(handlers: ActionHandler[M, _]*): HandlerFunction

Combines multiple ActionHandlers into a single partial function
def dispatch(action: AnyRef): Unit

Dispatch the action, call change listeners when completed
Dispatch the action, call change listeners when completed
action
Action to dispatch

Definition Classes
Circuit → Dispatcher
def dispatchBase(action: AnyRef): Unit

Perform actual dispatching, without calling change listeners
Perform actual dispatching, without calling change listeners

Attributes
protected
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def handleError(msg: String): Unit

Handle a non-fatal error, such as dispatching an action with no action handler.
Handle a non-fatal error, such as dispatching an action with no action handler.
msg
Error message
def handleFatal(action: AnyRef, e: Throwable): Unit

Handle a fatal error.
Handle a fatal error. Override this function to do something with exceptions that occur while dispatching actions.
action
Action that caused the exception
e
Exception that was thrown
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def removeProcessor(processor: ActionProcessor): Unit

Removes a previously added ActionProcessor from the action processing chain.
def subscribe(listener: Listener, cursor: Cursor = m => m): () ⇒ Unit

Subscribes to listen to changes in the model.
Subscribes to listen to changes in the model. By providing a cursor you can limit what part of the model must change for your listener to be called. If omitted, all changes result in a call.
listener
Function to be called when model is updated
cursor
Cursor function returning the part of the model you are interested in. By default this is the root model, which means your listener is called on any change in the model.
returns
A function to unsubscribe your listener
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
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 zoom[T](get: (M) ⇒ T): ModelR[T]

Zoom into the model using the get function
Zoom into the model using the get function
get
Function that returns the part of the model you are interested in
returns
A ModelR[T] giving you read-only access to part of the model
def zoomRW[T](get: (M) ⇒ T)(set: (M, T) ⇒ M): ModelRW[M, T]

Zoom into the model using get and set functions
Zoom into the model using get and set functions
get
Function that returns the part of the model you are interested in
set
Function that updates the part of the model you are interested in
returns
A ModelRW[T] giving you read/update access to part of the model

Related Doc: package diode

trait Circuit[M <: AnyRef] extends Dispatcher

Type Members

type Cursor = (M) ⇒ AnyRef

type HandlerFunction = PartialFunction[AnyRef, ActionResult[M]]

type Listener = () ⇒ Unit

Abstract Value Members

abstract def actionHandler: HandlerFunction

abstract val model: M

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addProcessor(processor: ActionProcessor): Unit

def apply(action: AnyRef): Unit

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def combineHandlers(handlers: ActionHandler[M, _]*): HandlerFunction

def dispatch(action: AnyRef): Unit

def dispatchBase(action: AnyRef): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def handleError(msg: String): Unit

def handleFatal(action: AnyRef, e: Throwable): Unit

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def removeProcessor(processor: ActionProcessor): Unit

def subscribe(listener: Listener, cursor: Cursor = m => m): () ⇒ Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def zoom[T](get: (M) ⇒ T): ModelR[T]

def zoomRW[T](get: (M) ⇒ T)(set: (M, T) ⇒ M): ModelRW[M, T]

Inherited from Dispatcher

Inherited from AnyRef

Inherited from Any

Ungrouped