Class InitializableViewModelBase`Abstract`

Базовая вью модель с возможностью инициализации.

Hierarchy (View Summary)

ViewModelBase
- InitializableViewModelBase

Implements

IInitializableViewModelBase

Index

Constructors

constructor

new InitializableViewModelBase(): InitializableViewModelBase
Returns InitializableViewModelBase
Overrides ViewModelBase.constructor
- Defined in @tessa/ui/src/viewModel/initializableViewModelBase.ts:15

Properties

`Readonly`disposeList

disposeList: DisposeList

Функции, которые будут вызваны в конце жизненного цикла вью модели. Может использоваться для очистки связанных объектов, если их жизненный цикл совпадает с жизненным циклом вью модели.

Example

vm.disposeList.add(reaction(
  () => vm.isMounted,
  v => console.log(`vm.isMounted = ${v}`)
));

info

info: null | IStorage = null

Default

null

`Readonly`onContextResolved

onContextResolved: EventHandler<UIContext, IViewModelBase>

Событие вызывается когда UI контекст был получен вью моделью.

`Readonly`onInitialized

onInitialized: EventHandler<EmptyEvent, IInitializableViewModelBase>

Событие вызывается после инициализации вью-модели.

`Readonly`onInitializing

onInitializing: EventHandler<EmptyEvent, IInitializableViewModelBase>

Событие вызывается перед инициализацией вью-модели.

`Readonly`onReady

onReady: EventHandler<EmptyEvent, IViewModelBase>

Событие вызывается когда вью модель готова к использованию. Событие может вызываться несколько раз за время жизни вью модели. Обработчик может вернуть функцию очистки, которая будет вызвана, когда вью модель перестанет считаться готовой к работе, т.е. компонент размонтирован или вызван dispose вью модели.

Example

vm.onReady.add(() => {
 console.log('ready');
 return () => console.log('unready');
});

`Readonly`uiId

uiId: number

Уникальный идентификатор UI элемента.

Accessors

alias

get alias(): string
Returns string
Default
```
empty string
```
Implementation of IInitializableViewModelBase.alias
Inherited from ViewModelBase.alias
- Defined in @tessa/ui/src/viewModel/viewModelBase.ts:67
set alias(value: string): void
Псевдоним модели представления.
Parameters
- value: string
Returns void
Implementation of IInitializableViewModelBase.alias
Inherited from ViewModelBase.alias
- Defined in @tessa/ui/src/viewModel/viewModelBase.ts:70

isInitialized

get isInitialized(): boolean
Indicates that object has already been initialized.

Returns boolean
Implementation of IInitializableViewModelBase.isInitialized
- Defined in @tessa/ui/src/viewModel/initializableViewModelBase.ts:41

isMounted

get isMounted(): boolean
Флаг указывающий на то, что вью компонент смонтирован.

Returns boolean
Implementation of IInitializableViewModelBase.isMounted
Inherited from ViewModelBase.isMounted
- Defined in @tessa/ui/src/viewModel/viewModelBase.ts:55

isReady

get isReady(): boolean
Флаг указывающий на то, что вью модель готова к работе.

Returns boolean
Implementation of IInitializableViewModelBase.isReady
Inherited from ViewModelBase.isReady
- Defined in @tessa/ui/src/viewModel/viewModelBase.ts:60

Methods

dispose

dispose(): void
Returns void
Implementation of IInitializableViewModelBase.dispose
Inherited from ViewModelBase.dispose
- Defined in @tessa/ui/src/viewModel/viewModelBase.ts:83

initialize

initialize(): Promise<void>
Initializes the object.

Returns Promise<void>
Implementation of IInitializableViewModelBase.initialize
- Defined in @tessa/ui/src/viewModel/initializableViewModelBase.ts:69

mount

mount(
    params?: {
        actionsRef?: ViewModelBaseComponentRef<unknown>;
        context?: UIContext;
        ref?: ViewModelBaseComponentRef;
    },
): Promise<void>
Метод вызывается при монтировании вью компонента и может передавать ссылку на сам компонент.
Parameters
- Optionalparams: {
      actionsRef?: ViewModelBaseComponentRef<unknown>;
      context?: UIContext;
      ref?: ViewModelBaseComponentRef;
  }
  - OptionalactionsRef?: ViewModelBaseComponentRef<unknown>
    Ссылка на императивные методы вью компонента.
  - Optionalcontext?: UIContext
    Контекст текущего дерева UI.
  - Optionalref?: ViewModelBaseComponentRef
    Ссылка на вью компонент.
Returns Promise<void>
Implementation of IInitializableViewModelBase.mount
Inherited from ViewModelBase.mount
- Defined in @tessa/ui/src/viewModel/viewModelBase.ts:98

tryGetComponentActionsRef

tryGetComponentActionsRef<T = object>(): null | T
Ссылка на императивные методы вью компонента.
Type Parameters
- T = object
Returns null | T
Implementation of IInitializableViewModelBase.tryGetComponentActionsRef
Inherited from ViewModelBase.tryGetComponentActionsRef
- Defined in @tessa/ui/src/viewModel/viewModelBase.ts:154

tryGetComponentRef

tryGetComponentRef<T = Element>(): null | T
Ссылка на вью компонент.
Type Parameters
- T = Element
Returns null | T
Implementation of IInitializableViewModelBase.tryGetComponentRef
Inherited from ViewModelBase.tryGetComponentRef
- Defined in @tessa/ui/src/viewModel/viewModelBase.ts:146

unmount

unmount(): Promise<void>
Метод вызывается при размонтировании вью компонента.

Returns Promise<void>
Implementation of IInitializableViewModelBase.unmount
Inherited from ViewModelBase.unmount
- Defined in @tessa/ui/src/viewModel/viewModelBase.ts:120

waitInitialized

waitInitialized(): Promise<void>
Дождаться, пока вью-модель не будет проинициализирована.

Returns Promise<void>
Remarks
Метод не вызывает инициализацию вью-модели.
Implementation of IInitializableViewModelBase.waitInitialized
- Defined in @tessa/ui/src/viewModel/initializableViewModelBase.ts:73

Class InitializableViewModelBaseAbstract

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns InitializableViewModelBase

Properties

ReadonlydisposeList

Example

info

Default

ReadonlyonContextResolved

ReadonlyonInitialized

ReadonlyonInitializing

ReadonlyonReady

Example

ReadonlyuiId

Accessors

alias

Returns string

Default

Parameters

Returns void

isInitialized

Returns boolean

isMounted

Returns boolean

isReady

Returns boolean

Methods

dispose

Returns void

initialize

Returns Promise<void>

mount

Parameters

OptionalactionsRef?: ViewModelBaseComponentRef<unknown>

Optionalcontext?: UIContext

Optionalref?: ViewModelBaseComponentRef

Returns Promise<void>

tryGetComponentActionsRef

Type Parameters

Returns null | T

tryGetComponentRef

Type Parameters

Returns null | T

unmount

Returns Promise<void>

waitInitialized

Returns Promise<void>

Remarks

Settings

On This Page

Class InitializableViewModelBase`Abstract`

`Readonly`disposeList

`Readonly`onContextResolved

`Readonly`onInitialized

`Readonly`onInitializing

`Readonly`onReady

`Readonly`uiId

`Optional`actionsRef?: ViewModelBaseComponentRef<unknown>

`Optional`context?: UIContext

`Optional`ref?: ViewModelBaseComponentRef