Class StateManager<CONTROL>

Type Parameters

CONTROL extends MFC

Hierarchy (View Summary)

BaseManager<MargaritaFormState>
- StateManager

Index

Constructors

Properties

_value control initialValue? subscriptions managerName

Accessors

changes name otherChanges value

Methods

afterInitialize cleanup createSubscription emitChange findState onCleanup onInitialize prepare registerState registerStates resetState toJSON updateState updateStates validate

Constructors

constructor

new StateManager<CONTROL extends MFC>(control: CONTROL): StateManager<CONTROL>
Type Parameters
- CONTROL extends MFC
Parameters
- control: CONTROL
Returns StateManager<CONTROL>
Overrides BaseManager.constructor
- Defined in managers/state-manager.ts:61

Properties

_value

_value: MargaritaFormState = ...

control

control: CONTROL

`Optional`initialValue

initialValue?: MargaritaFormState

subscriptions

subscriptions: Subscription[] = []

`Static`managerName

managerName: keyof Managers = 'state'

Accessors

changes

get changes(): Observable<VALUE>
Returns Observable<VALUE>
Inherited from BaseManager.changes
- Defined in managers/base-manager.ts:32

name

get name(): keyof Managers
Returns keyof Managers
Inherited from BaseManager.name
- Defined in managers/base-manager.ts:27

otherChanges

get otherChanges(): Observable<unknown>
Returns Observable<unknown>
Inherited from BaseManager.otherChanges
- Defined in managers/base-manager.ts:41

value

get value(): any
Returns any
Overrides BaseManager.value
- Defined in managers/state-manager.ts:77
set value(value: any): void
Parameters
- value: any
Returns void
Overrides BaseManager.value
- Defined in managers/state-manager.ts:92

Methods

afterInitialize

afterInitialize(): void
Returns void
Overrides BaseManager.afterInitialize
- Defined in managers/state-manager.ts:102

cleanup

cleanup(): void
Returns void
Inherited from BaseManager.cleanup
- Defined in managers/base-manager.ts:71

createSubscription

createSubscription<VALUE = unknown>(
observable: Observable<VALUE>,
callback: (value: VALUE) => any,
): void
Type Parameters
- VALUE = unknown
Parameters
- observable: Observable<VALUE>
- callback: (value: VALUE) => any
Returns void
Inherited from BaseManager.createSubscription
- Defined in managers/base-manager.ts:77

emitChange

emitChange<VALUE = unknown>(change: VALUE): Promise<MargaritaFormState>
Type Parameters
- VALUE = unknown
Parameters
- change: VALUE
Returns Promise<MargaritaFormState>
Inherited from BaseManager.emitChange
- Defined in managers/base-manager.ts:49

findState

findState(key: keyof MargaritaFormState): undefined | StateClass
Internal
Parameters
- key: keyof MargaritaFormState
Returns undefined | StateClass
- Defined in managers/state-manager.ts:372

onCleanup

onCleanup(): void
Returns void
Inherited from BaseManager.onCleanup
- Defined in managers/base-manager.ts:67

onInitialize

onInitialize(): void
Returns void
Inherited from BaseManager.onInitialize
- Defined in managers/base-manager.ts:59

prepare

prepare(): void
Returns void
Overrides BaseManager.prepare
- Defined in managers/state-manager.ts:98

registerState

registerState(state: StateClass): void
Internal
Parameters
- state: StateClass
Returns void
- Defined in managers/state-manager.ts:358

registerStates

registerStates(states: StateClass[]): void
Internal
Parameters
- states: StateClass[]
Returns void
- Defined in managers/state-manager.ts:365

resetState

resetState(respectField?: boolean): void
Parameters
- respectField: boolean = false
Returns void
- Defined in managers/state-manager.ts:323

toJSON

toJSON(internal?: boolean): MargaritaFormState
Parameters
- internal: boolean = false
Returns MargaritaFormState
- Defined in managers/state-manager.ts:376

updateState

updateState(
    key: keyof MargaritaFormState,
    value: any,
    emit?: boolean,
): Promise<boolean>
Parameters
- key: keyof MargaritaFormState
- value: any
- emit: boolean = true
Returns Promise<boolean>
- Defined in managers/state-manager.ts:276

updateStates

updateStates(
changes: Partial<MargaritaFormState>,
emit?: boolean,
): Promise<boolean>
Parameters
- changes: Partial<MargaritaFormState>
- emit: boolean = true
Returns Promise<boolean>
- Defined in managers/state-manager.ts:282

validate

validate(setAsTouched?: boolean): Promise<boolean>
Validate the control and update state. Mark the control as touched to show errors.
Parameters
- setAsTouched: boolean = true
  Set the touched state to true
Returns Promise<boolean>
- Defined in managers/state-manager.ts:297