File

projects/netgrif-components-core/src/lib/routing/view-service/view.service.ts

Description

Holds information about views in the application. Can be used to resolve view component class objects from their names.

Index

Methods

Constructor

Protected constructor(componentClasses: Array, configService: ConfigurationService, _router: Router, _logger: LoggerService)
Parameters :
Name Type Optional Description
componentClasses Array<Type | ViewEntry> No

Class objects of view components that should be dynamically routed

configService ConfigurationService No

application's ConfigurationService

_router Router No

the application's Router

_logger LoggerService No

application's logging service

Methods

Public resolveNameToClass
resolveNameToClass(componentClassName: string)
Parameters :
Name Type Optional Description
componentClassName string No

class name of a view component

Returns : Type | undefined

the Class object with the provided name or null if such name is not registered

import {Type} from '@angular/core';
import {ConfigurationService} from '../../configuration/configuration.service';
import {LoggerService} from '../../logger/services/logger.service';
import {Router} from '@angular/router';
import {ViewEntry} from './model/view-entry';

/**
 * Holds information about views in the application. Can be used to resolve view component class objects from their names.
 */
export abstract class ViewService {

    /**
     * @ignore
     * Stores a mapping of component names to their classes
     */
    private _nameToClass: Map<string, Type<any>>;

    /**
     * @param componentClasses Class objects of view components that should be dynamically routed
     * @param configService application's ConfigurationService
     * @param _router the application's Router
     * @param _logger application's logging service
     */
    protected constructor(componentClasses: Array<Type<any> | ViewEntry>,
                          // TODO 29.4.2021 - remove unused class attributes
                          configService: ConfigurationService,
                          protected _router: Router,
                          protected _logger: LoggerService) {
        this._nameToClass = new Map<string, Type<any>>();
        componentClasses.forEach(component => {
            if (component instanceof Type) {
                this._nameToClass.set(component.name, component);
            } else {
                this._nameToClass.set(component.id, component.class);
            }
        });
    }

    /**
     * @param componentClassName class name of a view component
     * @returns the Class object with the provided name or `null` if such name is not registered
     */
    public resolveNameToClass(componentClassName: string): Type<any> | undefined {
        return this._nameToClass.get(componentClassName);
    }
}

results matching ""

    No results matching ""