Class BindingTwoWay

Provides two way data binding between Observers and IBindable elements. This means that when the value of the Observers changes the IBindable will be updated and vice versa.

Hierarchy (view full)

BindingBase
- BindingTwoWay

Index

Constructors

Accessors

applyingChange element historyCombine historyEnabled historyName historyPostfix historyPrefix linked observers paths

Constructors

constructor

new BindingTwoWay(args?): BindingTwoWay
Creates a new BindingTwoWay instance.
Parameters
- args: Readonly<BindingTwoWayArgs> = {}
  The arguments.
Returns BindingTwoWay
Overrides BindingBase.constructor
- Defined in pcui/src/binding/BindingTwoWay/index.ts:33

Accessors

applyingChange

get applyingChange(): boolean
Returns boolean
Overrides BindingBase.applyingChange
- Defined in pcui/src/binding/BindingTwoWay/index.ts:119

element

get element(): IBindable
Returns IBindable
Overrides BindingBase.element
- Defined in pcui/src/binding/BindingTwoWay/index.ts:107

historyCombine

get historyCombine(): boolean
Returns boolean
Overrides BindingBase.historyCombine
- Defined in pcui/src/binding/BindingTwoWay/index.ts:127

historyEnabled

get historyEnabled(): any
Returns any
Overrides BindingBase.historyEnabled
- Defined in pcui/src/binding/BindingTwoWay/index.ts:151

historyName

get historyName(): string
Returns string
Inherited from BindingBase.historyName
- Defined in pcui/src/binding/BindingBase/index.ts:213
set historyName(value): void
The name of the history action when applying changes to observers.
Parameters
- value: string
Returns void
Inherited from BindingBase.historyName
- Defined in pcui/src/binding/BindingBase/index.ts:209

historyPostfix

get historyPostfix(): string
Returns string
Overrides BindingBase.historyPostfix
- Defined in pcui/src/binding/BindingTwoWay/index.ts:143

historyPrefix

get historyPrefix(): string
Returns string
Overrides BindingBase.historyPrefix
- Defined in pcui/src/binding/BindingTwoWay/index.ts:135

linked

get linked(): boolean
Whether the binding is linked to observers.

Returns boolean
Inherited from BindingBase.linked
- Defined in pcui/src/binding/BindingBase/index.ts:191

observers

get observers(): Observer[]
The linked observers.

Returns Observer[]
Inherited from BindingBase.observers
- Defined in pcui/src/binding/BindingBase/index.ts:257

paths

get paths(): string[]
The linked paths.

Returns string[]
Inherited from BindingBase.paths
- Defined in pcui/src/binding/BindingBase/index.ts:264