Class MenuInstaller<TAction, TContext>

Abstract base class for installing Menu components and services.

Inheritance

object

MenuInstaller<TAction, TContext>

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Serenity.Menu.Installation.Installers

Assembly: Serenity.Menu.Installation.dll

Syntax

public abstract class MenuInstaller<TAction, TContext> where TAction : IDisposable

Type Parameters

Name	Description
TAction
TContext

Remarks

This class provides the foundational structure for setting up Menu-related functionalities, including views, view models, presenters, use cases, services, and controllers.

Constructors

MenuInstaller()

Declaration

protected MenuInstaller()

Fields

_foundationViewElementFactory

Declaration

protected IFoundationViewElementFactory _foundationViewElementFactory

Field Value

Type	Description
IFoundationViewElementFactory	The factory for creating foundation view elements.

_menuController

Declaration

protected IUiController<TAction, TContext> _menuController

Field Value

Type	Description
IUiController<TAction, TContext>	The controller for the menu.

_menuControllerFactory

Declaration

protected IMenuControllerFactory<TAction, TContext> _menuControllerFactory

Field Value

Type	Description
IMenuControllerFactory<TAction, TContext>	The factory for creating menu controllers.

_menuPresenterFactory

Declaration

protected IMenuPresenterFactory _menuPresenterFactory

Field Value

Type	Description
IMenuPresenterFactory	The factory for creating menu presenters.

_menuService

Declaration

protected IMenuService _menuService

Field Value

Type	Description
IMenuService	The factory for creating menu services.

_menuServiceFactory

Declaration

protected IMenuServiceFactory _menuServiceFactory

Field Value

Type	Description
IMenuServiceFactory	The factory for creating menu services.

_menuServiceSettings

Declaration

protected IMenuServiceSettingsDefinition _menuServiceSettings

Field Value

Type	Description
IMenuServiceSettingsDefinition	The settings definition for the menu service.

_menuViewFactory

Declaration

protected IMenuViewFactory _menuViewFactory

Field Value

Type	Description
IMenuViewFactory	The factory for creating menu views.

_menuViewModelFactory

Declaration

protected IMenuViewModelFactory _menuViewModelFactory

Field Value

Type	Description
IMenuViewModelFactory	The factory for creating menu view models.

_menuViews

Declaration

protected Dictionary<string, IViewBase> _menuViews

Field Value

Type	Description
Dictionary<string, IViewBase>	Dictionary mapping menu view names to their instances.

_presenter

Declaration

protected IMenuPresenter _presenter

Field Value

Type	Description
IMenuPresenter	The presenter for the menu.

_uiOptionFactory

Declaration

protected UiOptionFactory _uiOptionFactory

Field Value

Type	Description
UiOptionFactory	The factory for creating UI option elements.

_uiOptionSettings

Declaration

protected IMenuSettingsDefinition[] _uiOptionSettings

Field Value

Type	Description
IMenuSettingsDefinition[]	Array of settings definitions for individual menu options.

_useCases

Declaration

protected MenuUseCases _useCases

Field Value

Type	Description
MenuUseCases	The use cases for the menu.

_viewModels

Declaration

protected Dictionary<string, IViewModel> _viewModels

Field Value

Type	Description
Dictionary<string, IViewModel>	Dictionary mapping menu view model names to their instances.

Methods

GetController()

Gets the menu controller.

Declaration

public IUiController<TAction, TContext> GetController()

Returns

Type	Description
IUiController<TAction, TContext>	The controller for the menu.

GetMenuControllerFactory()

Gets the menu controller factory.

Declaration

public IMenuControllerFactory<TAction, TContext> GetMenuControllerFactory()

Returns

Type	Description
IMenuControllerFactory<TAction, TContext>	The factory for creating menu controllers.

GetMenuPresenterFactory()

Gets the foundation view element factory.

Declaration

public IMenuPresenterFactory GetMenuPresenterFactory()

Returns

Type	Description
IMenuPresenterFactory	The factory for creating foundation view elements.

GetMenuServiceFactory()

Gets the menu service factory.

Declaration

public IMenuServiceFactory GetMenuServiceFactory()

Returns

Type	Description
IMenuServiceFactory	The factory for creating menu services.

GetMenuServiceSettings()

Gets the menu service settings.

Declaration

public IMenuServiceSettingsDefinition GetMenuServiceSettings()

Returns

Type	Description
IMenuServiceSettingsDefinition	The settings for the menu service.

GetMenuViewFactory()

Gets the foundation view element factory.

Declaration

public IMenuViewFactory GetMenuViewFactory()

Returns

Type	Description
IMenuViewFactory	The factory for creating foundation view elements.

GetMenuViewModelFactory()

Gets the menu view model factory.

Declaration

public IMenuViewModelFactory GetMenuViewModelFactory()

Returns

Type	Description
IMenuViewModelFactory	The factory for creating menu view models.

GetMenuViewModels()

Gets the menu view models.

Declaration

public Dictionary<string, IViewModel> GetMenuViewModels()

Returns

Type	Description
Dictionary<string, IViewModel>	A dictionary mapping menu view model names to their instances.

GetMenuViews()

Gets the menu views.

Declaration

public Dictionary<string, IViewBase> GetMenuViews()

Returns

Type	Description
Dictionary<string, IViewBase>	A dictionary mapping menu view names to their instances.

GetPresenter()

Gets the menu presenter.

Declaration

public IMenuPresenter GetPresenter()

Returns

Type	Description
IMenuPresenter	The presenter for the menu.

GetService()

Gets the foundation view element factory.

Declaration

public IMenuService GetService()

Returns

Type	Description
IMenuService	The factory for creating foundation view elements.

GetUiOptionFactory()

Gets the UiOptionFactory.

Declaration

public UiOptionFactory GetUiOptionFactory()

Returns

Type	Description
UiOptionFactory	The factory for creating UI options.

GetUiOptionSettings()

Gets the UI option settings.

Declaration

public IMenuSettingsDefinition[] GetUiOptionSettings()

Returns

Type	Description
IMenuSettingsDefinition[]	An array of settings definitions for individual menu options.

GetUseCases()

Gets the menu use cases.

Declaration

public MenuUseCases GetUseCases()

Returns

Type	Description
MenuUseCases	The use cases for the menu.

Install(MenuInstallerInstallInput<TAction, TContext>)

Installs the menu components and services.

Declaration

public abstract void Install(MenuInstallerInstallInput<TAction, TContext> input)

Parameters

Type	Name	Description
MenuInstallerInstallInput<TAction, TContext>	input	The installation input data transfer object.

InstallUseCases(IMenuPresenter)

Installs the menu use cases.

Declaration

protected MenuUseCases InstallUseCases(IMenuPresenter presenter)

Parameters

Type	Name	Description
IMenuPresenter	presenter	The menu presenter instance.

Returns

Type	Description
MenuUseCases