Class Bindable<T>

Represent the class have the default value

Type Parameters

T

Implements

IBindable<T>

Index

Constructors

Accessors

bindTarget defaultValue value

Methods

DereferenceTo ReferenceTo bindTo copyTo getEditableCopy onDefaultValueChanged onValueChanged unbind

Constructors

constructor

new Bindable<T>(defaultValue): Bindable<T>
Type Parameters
- T
Parameters
- defaultValue: T
Returns Bindable<T>
- Defined in workspaces/core/src/Bindables/Bindable.ts:110

Accessors

bindTarget

get bindTarget(): undefined | IBindable<T>
The bind target of the bind, null when it didn't bind o other

Returns undefined | IBindable<T>
Implementation of IBindable.bindTarget
- Defined in workspaces/core/src/Bindables/Bindable.ts:90

defaultValue

get defaultValue(): T
Returns T
Implementation of IBindable.defaultValue
- Defined in workspaces/core/src/Bindables/Bindable.ts:80
set defaultValue(newValue): void
Parameters
- newValue: T
Returns void
Implementation of IBindable.defaultValue
- Defined in workspaces/core/src/Bindables/Bindable.ts:83

value

get value(): T
The value of the binding

Returns T
Implementation of IBindable.value
- Defined in workspaces/core/src/Bindables/Bindable.ts:95
set value(newValue): void
The value of the binding
Parameters
- newValue: T
Returns void
Implementation of IBindable.value
- Defined in workspaces/core/src/Bindables/Bindable.ts:98

Methods

`Protected`DereferenceTo

DereferenceTo(id): void
Parameters
- id: number
Returns void
- Defined in workspaces/core/src/Bindables/Bindable.ts:178

`Protected`ReferenceTo

ReferenceTo(target): number
Parameters
- target: Bindable<T>
Returns number
- Defined in workspaces/core/src/Bindables/Bindable.ts:174

bindTo

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

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
Implementation of IBindable.copyTo
- Defined in workspaces/core/src/Bindables/Bindable.ts:169

getEditableCopy

getEditableCopy(): Bindable<T>
Returns Bindable<T>
- Defined in workspaces/core/src/Bindables/Bindable.ts:196

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
- runImmediately: boolean = false
  will it run once just after the event was register?
Returns void
Implementation of IBindable.onDefaultValueChanged
- Defined in workspaces/core/src/Bindables/Bindable.ts:156

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
- runImmediately: boolean = false
  will it run once just after the event was register?
Returns void
Implementation of IBindable.onValueChanged
- Defined in workspaces/core/src/Bindables/Bindable.ts:131

unbind

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

Returns void
Implementation of IBindable.unbind
- Defined in workspaces/core/src/Bindables/Bindable.ts:191