Property

Abstract Value Members

abstract 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.
abstract 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.
abstract def clearListeners(): Unit

Removes all listeners from property.
abstract 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.
abstract def fireValueListeners(): Unit

Fires value listeners.
Fires value listeners.

Attributes
protected[io.udash.properties]
Definition Classes
ReadableProperty
abstract def get: A

returns
Current property value.

Definition Classes
ReadableProperty
abstract val id: PropertyId

Unique property ID.
Unique property ID.

Definition Classes
ReadableProperty
abstract def isValid: Future[ValidationResult]

returns
validation result as Future, which will be completed on the validation process ending. It can fire validation process if needed.

Definition Classes
ReadableProperty
abstract 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
ReadableProperty
abstract 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
ReadableProperty
abstract def listenersCount(): Int

Returns listeners count.
Returns listeners count.

Definition Classes
ReadableProperty
abstract 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
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 readable: ReadableProperty[A]

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

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.
abstract def setInitValue(t: A): Unit

Changes current property value.
Changes current property value. Does not fire value change listeners.
abstract 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
ReadableProperty
abstract 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.
abstract def touch(): Unit

Fires value change listeners with current value and clears validation result.
abstract 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].
abstract 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
ReadableProperty
abstract 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].
abstract 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
ReadableProperty
abstract def valid: ReadableProperty[ValidationResult]

Property containing validation result.
Property containing validation result.

Definition Classes
ReadableProperty
abstract def validate(): Unit

Triggers validation.
Triggers validation.

Attributes
protected[io.udash.properties]
Definition Classes
ReadableProperty
abstract 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
ReadableProperty

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
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] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
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
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( ... )

Related Docs: object Property | package single

trait Property[A] extends ReadableProperty[A]

Abstract Value Members

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

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

abstract def clearListeners(): Unit

abstract def clearValidators(): Unit

abstract def fireValueListeners(): Unit

abstract def get: A

abstract val id: PropertyId

abstract def isValid: Future[ValidationResult]

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

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

abstract def listenersCount(): Int

abstract def listenersUpdate(): Unit

abstract def parent: ReadableProperty[_]

abstract def readable: ReadableProperty[A]

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

abstract def setInitValue(t: A): Unit

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

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

abstract def touch(): Unit

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

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

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

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

abstract def valid: ReadableProperty[ValidationResult]

abstract def validate(): Unit

abstract def valueChanged(): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

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

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): 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

Inherited from ReadableProperty[A]

Inherited from AnyRef

Inherited from Any

Ungrouped