Class ModalInstaller<TAction, TContext>
Abstract installer class for setting up modal components and services.
Inherited Members
Namespace: Serenity.Modal.Installation.Installers
Assembly: Serenity.Modal.Installation.dll
Syntax
public abstract class ModalInstaller<TAction, TContext> where TAction : IDisposable
Type Parameters
| Name | Description |
|---|---|
| TAction | |
| TContext |
Constructors
ModalInstaller()
Declaration
protected ModalInstaller()
Fields
_foundationViewElementFactory
Declaration
protected IFoundationViewElementFactory _foundationViewElementFactory
Field Value
| Type | Description |
|---|---|
| IFoundationViewElementFactory | Factory for creating foundation view elements. |
_modalComponentFactory
Declaration
protected IUiComponentFactory _modalComponentFactory
Field Value
| Type | Description |
|---|---|
| IUiComponentFactory | Factory for creating modal components. |
_modalController
Declaration
protected IUiController<TAction, TContext> _modalController
Field Value
| Type | Description |
|---|---|
| IUiController<TAction, TContext> | Modal controller. |
_modalControllerFactory
Declaration
protected IModalControllerFactory<TAction, TContext> _modalControllerFactory
Field Value
| Type | Description |
|---|---|
| IModalControllerFactory<TAction, TContext> | Modal controller factory. |
_modalPresenterFactory
Declaration
protected IModalPresenterFactory _modalPresenterFactory
Field Value
| Type | Description |
|---|---|
| IModalPresenterFactory | Factory for creating modal presenters. |
_modalService
Declaration
protected IModalService _modalService
Field Value
| Type | Description |
|---|---|
| IModalService | Modal service. |
_modalServiceFactory
Declaration
protected IModalServiceFactory _modalServiceFactory
Field Value
| Type | Description |
|---|---|
| IModalServiceFactory | Modal service factory. |
_modalServiceSettings
Declaration
protected IModalServiceSettingsDefinition _modalServiceSettings
Field Value
| Type | Description |
|---|---|
| IModalServiceSettingsDefinition | Modal service settings definition. |
_modalViewFactory
Declaration
protected IModalViewFactory _modalViewFactory
Field Value
| Type | Description |
|---|---|
| IModalViewFactory | Factory for creating modal views. |
_modalViewModelFactory
Declaration
protected IModalViewModelFactory _modalViewModelFactory
Field Value
| Type | Description |
|---|---|
| IModalViewModelFactory | Factory for creating modal view models. |
_modalViews
Declaration
protected Dictionary<string, IViewBase> _modalViews
Field Value
| Type | Description |
|---|---|
| Dictionary<string, IViewBase> | Dictionary of modal views. |
_presenter
Declaration
protected IModalPresenter _presenter
Field Value
| Type | Description |
|---|---|
| IModalPresenter | Modal presenter. |
_showModalComponentFactory
Declaration
protected IComponentFactory _showModalComponentFactory
Field Value
| Type | Description |
|---|---|
| IComponentFactory | Factory for creating components. |
_uiOptionFactory
Declaration
protected UiOptionFactory _uiOptionFactory
Field Value
| Type | Description |
|---|---|
| UiOptionFactory | Factory for creating UI options. |
_uiOptionSettings
Declaration
protected IModalSettingsDefinition[] _uiOptionSettings
Field Value
| Type | Description |
|---|---|
| IModalSettingsDefinition[] | Array of modal settings definitions. |
_useCases
Declaration
protected ModalUseCases _useCases
Field Value
| Type | Description |
|---|---|
| ModalUseCases | Modal use cases. |
_viewModels
Declaration
protected Dictionary<string, IViewModel> _viewModels
Field Value
| Type | Description |
|---|---|
| Dictionary<string, IViewModel> | Dictionary of modal view models. |
Methods
GetFoundationViewElementFactory()
Gets the foundation view element factory.
Declaration
public IFoundationViewElementFactory GetFoundationViewElementFactory()
Returns
| Type | Description |
|---|---|
| IFoundationViewElementFactory | The installed foundation view element factory. |
GetModalComponentFactory()
Gets the modal component factory.
Declaration
public IUiComponentFactory GetModalComponentFactory()
Returns
| Type | Description |
|---|---|
| IUiComponentFactory | The installed modal component factory. |
GetModalPresenterFactory()
Gets the modal presenter factory.
Declaration
public IModalPresenterFactory GetModalPresenterFactory()
Returns
| Type | Description |
|---|---|
| IModalPresenterFactory | The installed modal presenter factory. |
GetModalServiceSettings()
Gets the modal service settings.
Declaration
public IModalServiceSettingsDefinition GetModalServiceSettings()
Returns
| Type | Description |
|---|---|
| IModalServiceSettingsDefinition | The installed modal service settings. |
GetModalViewFactory()
Gets the modal view factory.
Declaration
public IModalViewFactory GetModalViewFactory()
Returns
| Type | Description |
|---|---|
| IModalViewFactory | The installed modal view factory. |
GetModalViewModelFactory()
Gets the modal view model factory.
Declaration
public IModalViewModelFactory GetModalViewModelFactory()
Returns
| Type | Description |
|---|---|
| IModalViewModelFactory | The installed modal view model factory. |
GetModalViewModels()
Gets the dictionary of modal view models.
Declaration
public Dictionary<string, IViewModel> GetModalViewModels()
Returns
| Type | Description |
|---|---|
| Dictionary<string, IViewModel> | A dictionary containing all registered modal view models. |
GetModalViews()
Gets the dictionary of modal views.
Declaration
public Dictionary<string, IViewBase> GetModalViews()
Returns
| Type | Description |
|---|---|
| Dictionary<string, IViewBase> | A dictionary containing all registered modal views. |
GetPresenter()
Gets the modal presenter.
Declaration
public IModalPresenter GetPresenter()
Returns
| Type | Description |
|---|---|
| IModalPresenter | The installed modal presenter. |
GetService()
Gets the modal service.
Declaration
public IModalService GetService()
Returns
| Type | Description |
|---|---|
| IModalService | The installed modal service. |
GetShowModalComponentFactory()
Gets the show modal component factory.
Declaration
public IComponentFactory GetShowModalComponentFactory()
Returns
| Type | Description |
|---|---|
| IComponentFactory | The installed show modal component factory. |
GetUiOptionFactory()
Gets the UI option factory.
Declaration
public UiOptionFactory GetUiOptionFactory()
Returns
| Type | Description |
|---|---|
| UiOptionFactory | The installed UI option factory. |
GetUiOptionSettings()
Gets the array of modal settings definitions.
Declaration
public IModalSettingsDefinition[] GetUiOptionSettings()
Returns
| Type | Description |
|---|---|
| IModalSettingsDefinition[] | An array containing all modal settings definitions. |
GetUseCases()
Gets the modal use cases.
Declaration
public ModalUseCases GetUseCases()
Returns
| Type | Description |
|---|---|
| ModalUseCases | The installed modal use cases. |
Install(ModalInstallerInstallInput<TAction, TContext>)
Installs the modal components and services using the provided input data.
Declaration
public abstract void Install(ModalInstallerInstallInput<TAction, TContext> input)
Parameters
| Type | Name | Description |
|---|---|---|
| ModalInstallerInstallInput<TAction, TContext> | input | Input data transfer object containing installation parameters. |
InstallUseCases(IModalPresenter)
Installs the modal use cases using the provided presenter.
Declaration
protected ModalUseCases InstallUseCases(IModalPresenter presenter)
Parameters
| Type | Name | Description |
|---|---|---|
| IModalPresenter | presenter | The presenter responsible for handling modal interactions. |
Returns
| Type | Description |
|---|---|
| ModalUseCases | An instance of ModalUseCases containing all installed use cases. |