Interface IBindable<T>

Represent the class have the default value

interface IBindable<T> {
    bindTarget?: IBindable<T>;
    defaultValue: T;
    value: T;
    bindTo(target: IBindable<T>): void;
    copyTo(target: IBindable<T>): void;
    onDefaultValueChanged(callback: ValueChangedCallback<T>, runImmediately?: boolean): void;
    onValueChanged(callback: ValueChangedCallback<T>, runImmediately?: boolean): void;
    unbind(): void;
}

Type Parameters

T

Hierarchy (view full)

IHasDefaultValue<T>
- IBindable

Implemented by

Bindable

Index

Properties

bindTarget? defaultValue value

Methods

bindTo copyTo onDefaultValueChanged onValueChanged unbind

Properties

`Optional` `Readonly`bindTarget

bindTarget?: IBindable<T>

The bind target of the bind, null when it didn't bind o other

defaultValue

defaultValue: T

value

value: T

The value of the binding

Methods

bindTo

bindTo(target): void
Bind this binding to other, the value will be synced
Parameters
- target: IBindable<T>
Returns void
- Defined in workspaces/core/src/Bindables/Bindable.ts:36

copyTo

copyTo(target): void
Copy the value and defualt value to the target, can be useful when the value only need to be sync once
Parameters
- target: IBindable<T>
  the target binding
Returns void
- Defined in workspaces/core/src/Bindables/Bindable.ts:67

onDefaultValueChanged

onDefaultValueChanged(callback, runImmediately?): void
Register a callback to the default value change event
Parameters
- callback: ValueChangedCallback<T>
  the callback function when the default value was change
- OptionalrunImmediately: boolean
  will it run once just after the event was register?
Returns void
- Defined in workspaces/core/src/Bindables/Bindable.ts:53

onValueChanged

onValueChanged(callback, runImmediately?): void
Register a callback to the value change event
Parameters
- callback: ValueChangedCallback<T>
  the callback function when the value was change
- OptionalrunImmediately: boolean
  will it run once just after the event was register?
Returns void
- Defined in workspaces/core/src/Bindables/Bindable.ts:43

unbind

unbind(): void
Will unbind from BindTarget, and the value will not longer be sync.

Returns void
- Defined in workspaces/core/src/Bindables/Bindable.ts:61