Class StateToggleManager

Manages the toggling of state properties based on specified paths. Every paths leading to boolean value will be initially set to false, then activities one will deactivate the others.

Index

Constructors

Accessors

Methods

deactivateAll destroy toggle filterValidTogglePaths

Constructors

constructor

new StateToggleManager(
togglePaths: string[],
stateManager: StateManager,
): StateToggleManager
Parameters
- togglePaths: string[]
- stateManager: StateManager
Returns StateToggleManager
- Defined in src/tools/state/stateToggleManager.ts:15

Accessors

state

get state(): State
Returns State
- Defined in src/tools/state/stateToggleManager.ts:24

Methods

deactivateAll

deactivateAll(): void
Set to false every state leaded by toggle paths.

Returns void
- Defined in src/tools/state/stateToggleManager.ts:51

destroy

destroy(): void
To call to destroy properly the component.

Returns void
- Defined in src/tools/state/stateToggleManager.ts:31

toggle

toggle(setPath: string, newValue: boolean): void
Set to false every state leaded by toggle paths except the specified one. Use the given value on the specified one.
Parameters
- setPath: string
- newValue: boolean
Returns void
- Defined in src/tools/state/stateToggleManager.ts:39

`Static`filterValidTogglePaths

filterValidTogglePaths(stateManager: StateManager, paths: string[]): string[]
Filters out invalid toggle paths from the given array of paths. Invalid path are path not leading to object in the state, or not leading to boolean value.
Parameters
- stateManager: StateManager
- paths: string[]
Returns string[]
Static
- Defined in src/tools/state/stateToggleManager.ts:98