ModelProperty

Abstract Value Members

abstract def get: A

returns
Current property value.

Definition Classes
ReadableProperty
abstract def getSubModel[T](getter: (A) ⇒ T, key: String): ReadableModelProperty[T]

Definition Classes
ModelPropertyMacroApi
abstract def getSubProperty[T](getter: (A) ⇒ T, key: String): ReadableProperty[T]

Definition Classes
ModelPropertyMacroApi
abstract def getSubSeq[T](getter: (A) ⇒ Seq[T], key: String): ReadableSeqProperty[T, ReadableProperty[T]]

Definition Classes
ModelPropertyMacroApi
abstract val id: PropertyId

Unique property ID.
Unique property ID.

Definition Classes
ReadableProperty
abstract def parent: ReadableProperty[_]

Parent property.
Parent property. null if this property has no parent.

Attributes
protected[io.udash.properties]
Definition Classes
ReadableProperty
abstract def set(t: A, force: Boolean = false): Unit

Changes current property value.
Changes current property value. Fires value change listeners.
t
Should not be null!
force
If true, the value change listeners will be fired even if value didn't change.

Definition Classes
Property
abstract def setInitValue(t: A): Unit

Changes current property value.
Changes current property value. Does not fire value change listeners.

Definition Classes
Property
abstract def touch(): Unit

Fires value change listeners with current value and clears validation result.
Fires value change listeners with current value and clears validation result.

Definition Classes
Property

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 addValidator(f: (A) ⇒ ValidationResult): Registration

Adds new validator and clears current validation result.
Adds new validator and clears current validation result. It does not fire validation process.

Definition Classes
AbstractProperty → Property
def addValidator(v: Validator[A]): Registration

Adds new validator and clears current validation result.
Adds new validator and clears current validation result. It does not fire validation process.

Definition Classes
AbstractProperty → Property
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clearListeners(): Unit

Removes all listeners from property.
Removes all listeners from property.

Definition Classes
AbstractProperty → Property
def clearValidators(): Unit

Removes all validators from property and clears current validation result.
Removes all validators from property and clears current validation result. It does not fire validation process.

Definition Classes
AbstractProperty → Property
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def combine[B, O](property: ReadableProperty[B], combinedParent: ReadableProperty[_] = null)(combiner: (A, B) ⇒ O)(implicit arg0: PropertyCreator[O]): ReadableProperty[O]

Combines two properties into a new one.
Combines two properties into a new one. Created property will be updated after any change in the origin ones.
B
Type of elements in provided property.
O
Output property elements type.
property
Property[B] to combine with this.
combinedParent
Parent of combined property, null by default.
combiner
Method combining values A and B into O.
returns
Property[O] updated on any change in this or property.

Definition Classes
ReadableProperty
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] )
def fireValueListeners(): Unit

Fires value listeners.
Fires value listeners.

Attributes
protected[io.udash.properties]
Definition Classes
AbstractReadableProperty → ReadableProperty
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
def isValid: Future[ValidationResult]

ModelProperty is valid if all validators return io.udash.properties.Valid and all subproperties are valid.
ModelProperty is valid if all validators return io.udash.properties.Valid and all subproperties are valid.
returns
Validation result as Future, which will be completed on the validation process ending. It can fire validation process if needed.

Definition Classes
AbstractReadableModelProperty → AbstractReadableProperty → ReadableProperty
def listen(valueListener: (A) ⇒ Any, initUpdate: Boolean = false): Registration

Registers listener which will be called on value change.
Registers listener which will be called on value change.
initUpdate
If true, listener will be instantly triggered with current value of property.

Definition Classes
AbstractReadableProperty → ReadableProperty
def listenOnce(valueListener: (A) ⇒ Any): Registration

Registers listener which will be called on the next value change.
Registers listener which will be called on the next value change. This listener will be fired only once.

Definition Classes
AbstractReadableProperty → ReadableProperty
final val listeners: Buffer[(A) ⇒ Any]

Attributes
protected[this]
Definition Classes
AbstractReadableProperty
def listenersCount(): Int

Returns listeners count.
Returns listeners count.

Definition Classes
AbstractReadableProperty → ReadableProperty
def listenersUpdate(): Unit

This method should be called when the listener is registered or removed.
This method should be called when the listener is registered or removed.

Attributes
protected[io.udash.properties]
Definition Classes
AbstractReadableProperty → ReadableProperty
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final val oneTimeListeners: Buffer[Registration]

Attributes
protected[this]
Definition Classes
AbstractReadableProperty
val properties: Map[String, Property[_]]

Attributes
protected
Definition Classes
AbstractReadableModelProperty
lazy val readable: ReadableModelProperty[A]

Ensures read-only access to this property.
Ensures read-only access to this property.

Definition Classes
AbstractReadableModelProperty → ReadableModelProperty → AbstractReadableProperty → ReadableProperty
macro def roSubModel[B](f: (A) ⇒ B)(implicit ev: ModelPropertyCreator[B]): ReadableModelProperty[B]

Returns child ModelProperty[B].
Returns child ModelProperty[B].

Definition Classes
ReadableModelProperty
macro def roSubProp[B](f: (A) ⇒ B)(implicit ev: PropertyCreator[B]): ReadableProperty[B]

Returns child DirectProperty[B].
Returns child DirectProperty[B].

Definition Classes
ReadableModelProperty
macro def roSubSeq[B](f: (A) ⇒ Seq[B])(implicit ev: SeqPropertyCreator[B]): ReadableSeqProperty[B, CastableReadableProperty[B]]

Returns child DirectSeqProperty[B]
Returns child DirectSeqProperty[B]

Definition Classes
ReadableModelProperty
def streamTo[B](target: Property[B], initUpdate: Boolean = true)(transformer: (A) ⇒ B): Registration

Streams value changes to the target property.
Streams value changes to the target property. It is not as strong relation as transform, because target can change value independently.

Definition Classes
AbstractReadableProperty → ReadableProperty
macro def subModel[B](f: (A) ⇒ B)(implicit ev: ModelPropertyCreator[B]): ModelProperty[B]

Returns child ModelProperty[B].
macro def subProp[B](f: (A) ⇒ B)(implicit ev: PropertyCreator[B]): Property[B]

Returns child DirectProperty[B].
macro def subSeq[B](f: (A) ⇒ Seq[B])(implicit ev: SeqPropertyCreator[B]): SeqProperty[B, CastableProperty[B]]

Returns child DirectSeqProperty[B]
def sync[B](p: Property[B])(transformer: (A) ⇒ B, revert: (B) ⇒ A): Registration

Bidirectionally synchronizes Property[B] with this.
Bidirectionally synchronizes Property[B] with this. The transformed value is synchronized from this to Property[B] on initialization.
B
Type of new Property.
p
Property to be synchronized with this.
transformer
Method transforming type A of existing Property to type B of new Property.
revert
Method transforming type B of new Property to type A of existing Property.
returns
Bidirectional registration between existing and new property.

Definition Classes
AbstractProperty → Property
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def transform[B](transformer: (A) ⇒ B, revert: (B) ⇒ A): Property[B]

Creates Property[B] linked to this.
Creates Property[B] linked to this. Changes will be bidirectionally synchronized between this and new property.
B
Type of new Property.
transformer
Method transforming type A of existing Property to type B of new Property.
revert
Method transforming type B of new Property to type A of existing Property.
returns
New Property[B], which will be synchronised with original Property[A].

Definition Classes
AbstractProperty → Property
def transform[B](transformer: (A) ⇒ B): ReadableProperty[B]

Creates ReadableProperty[B] linked to this.
Creates ReadableProperty[B] linked to this. Changes will be synchronized with this.
B
Type of new Property.
transformer
Method transforming type A of existing Property to type B of new Property.
returns
New ReadableProperty[B], which will be synchronised with original ReadableProperty[A].

Definition Classes
AbstractReadableProperty → ReadableProperty
def transformToSeq[B](transformer: (A) ⇒ Seq[B], revert: (Seq[B]) ⇒ A)(implicit arg0: PropertyCreator[B]): SeqProperty[B, Property[B]]

Creates SeqProperty[B] linked to this.
Creates SeqProperty[B] linked to this. Changes will be synchronized with this in both directions.
B
Type of elements in new SeqProperty.
transformer
Method transforming type A of existing Property to type Seq[B] of new Property.
revert
Method transforming type Seq[B] to A.
returns
New ReadableSeqProperty[B], which will be synchronised with original Property[A].

Definition Classes
AbstractProperty → Property
def transformToSeq[B](transformer: (A) ⇒ Seq[B])(implicit arg0: PropertyCreator[B]): ReadableSeqProperty[B, ReadableProperty[B]]

Creates ReadableSeqProperty[B] linked to this.
Creates ReadableSeqProperty[B] linked to this. Changes will be synchronized with this.
B
Type of elements in new SeqProperty.
transformer
Method transforming type A of existing Property to type Seq[B] of new Property.
returns
New ReadableSeqProperty[B], which will be synchronised with original ReadableProperty[A].

Definition Classes
AbstractReadableProperty → ReadableProperty
lazy val valid: ReadableProperty[ValidationResult]

Property containing validation result.
Property containing validation result.

Definition Classes
AbstractReadableProperty → ReadableProperty
def validate(): Unit

Triggers validation.
Triggers validation.

Attributes
protected[io.udash.properties]
Definition Classes
AbstractReadableProperty → ReadableProperty
final lazy val validationProperty: ValidationProperty[A]

Attributes
protected[this]
Definition Classes
AbstractReadableProperty
var validationResult: Future[ValidationResult]

Attributes
protected[this]
Definition Classes
AbstractReadableProperty
final val validators: Buffer[Validator[A]]

Attributes
protected[this]
Definition Classes
AbstractReadableProperty
def valueChanged(): Unit

This method should be called when the value has changed.
This method should be called when the value has changed.

Attributes
protected[io.udash.properties]
Definition Classes
AbstractReadableProperty → ReadableProperty
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 wrapListenerRegistration(reg: Registration): Registration

Attributes
protected
Definition Classes
AbstractReadableProperty
def wrapOneTimeListenerRegistration(reg: Registration): Registration

Attributes
protected
Definition Classes
AbstractReadableProperty

Related Docs: object ModelProperty | package model

trait ModelProperty[A] extends AbstractReadableModelProperty[A] with AbstractProperty[A]

Abstract Value Members

abstract def get: A

abstract def getSubModel[T](getter: (A) ⇒ T, key: String): ReadableModelProperty[T]

abstract def getSubProperty[T](getter: (A) ⇒ T, key: String): ReadableProperty[T]

abstract def getSubSeq[T](getter: (A) ⇒ Seq[T], key: String): ReadableSeqProperty[T, ReadableProperty[T]]

abstract val id: PropertyId

abstract def parent: ReadableProperty[_]

abstract def set(t: A, force: Boolean = false): Unit

abstract def setInitValue(t: A): Unit

abstract def touch(): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addValidator(f: (A) ⇒ ValidationResult): Registration

def addValidator(v: Validator[A]): Registration

final def asInstanceOf[T0]: T0

def clearListeners(): Unit

def clearValidators(): Unit

def clone(): AnyRef

def combine[B, O](property: ReadableProperty[B], combinedParent: ReadableProperty[_] = null)(combiner: (A, B) ⇒ O)(implicit arg0: PropertyCreator[O]): ReadableProperty[O]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def fireValueListeners(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def isValid: Future[ValidationResult]

def listen(valueListener: (A) ⇒ Any, initUpdate: Boolean = false): Registration

def listenOnce(valueListener: (A) ⇒ Any): Registration

final val listeners: Buffer[(A) ⇒ Any]

def listenersCount(): Int

def listenersUpdate(): Unit

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final val oneTimeListeners: Buffer[Registration]

val properties: Map[String, Property[_]]

lazy val readable: ReadableModelProperty[A]

macro def roSubModel[B](f: (A) ⇒ B)(implicit ev: ModelPropertyCreator[B]): ReadableModelProperty[B]

macro def roSubProp[B](f: (A) ⇒ B)(implicit ev: PropertyCreator[B]): ReadableProperty[B]

macro def roSubSeq[B](f: (A) ⇒ Seq[B])(implicit ev: SeqPropertyCreator[B]): ReadableSeqProperty[B, CastableReadableProperty[B]]

def streamTo[B](target: Property[B], initUpdate: Boolean = true)(transformer: (A) ⇒ B): Registration

macro def subModel[B](f: (A) ⇒ B)(implicit ev: ModelPropertyCreator[B]): ModelProperty[B]

macro def subProp[B](f: (A) ⇒ B)(implicit ev: PropertyCreator[B]): Property[B]

macro def subSeq[B](f: (A) ⇒ Seq[B])(implicit ev: SeqPropertyCreator[B]): SeqProperty[B, CastableProperty[B]]

def sync[B](p: Property[B])(transformer: (A) ⇒ B, revert: (B) ⇒ A): Registration

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

def toString(): String

def transform[B](transformer: (A) ⇒ B, revert: (B) ⇒ A): Property[B]

def transform[B](transformer: (A) ⇒ B): ReadableProperty[B]

def transformToSeq[B](transformer: (A) ⇒ Seq[B], revert: (Seq[B]) ⇒ A)(implicit arg0: PropertyCreator[B]): SeqProperty[B, Property[B]]

def transformToSeq[B](transformer: (A) ⇒ Seq[B])(implicit arg0: PropertyCreator[B]): ReadableSeqProperty[B, ReadableProperty[B]]

lazy val valid: ReadableProperty[ValidationResult]

def validate(): Unit

final lazy val validationProperty: ValidationProperty[A]

var validationResult: Future[ValidationResult]

final val validators: Buffer[Validator[A]]

def valueChanged(): Unit

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def wrapListenerRegistration(reg: Registration): Registration

def wrapOneTimeListenerRegistration(reg: Registration): Registration

Inherited from AbstractProperty[A]

Inherited from Property[A]

Inherited from AbstractReadableModelProperty[A]

Inherited from ModelPropertyMacroApi[A]

Inherited from ReadableModelProperty[A]

Inherited from AbstractReadableProperty[A]

Inherited from ReadableProperty[A]

Inherited from AnyRef

Inherited from Any

Ungrouped