File

projects/netgrif-components-core/src/lib/search/search-component/abstract-search.component.ts

Description

A universal search component that can be used to interactively create search predicates for anything with supported categories.

This component is responsible for the interactive creation of an AND ClausePredicate object instance. The nested Predicates are OR ClausePredicate instances created by AbstractSearchClauseComponent.

Search categories must be provided by the NAE_SEARCH_CATEGORIES injection token. Default factory methods for task and case search categories exist. See their documentation for more information.

The search component's visuals can be configured either by the NAE_SEARCH_COMPONENT_CONFIGURATION injection token, or by the appropriate component inputs. The injection token configuration takes precedence over the inputs if both are present.

Implements

SearchComponentConfiguration OnInit

Metadata

Index

Properties
Methods
Inputs
Accessors

Constructor

Protected constructor(_searchService: SearchService, _logger: LoggerService, _dialogService: DialogService, _translate: TranslateService, _allowedNetsService: AllowedNetsService, _viewIdService: ViewIdService, _searchCategories: Array<Type<Category<any>>>, _configuration: SearchComponentConfiguration, _filtersFilter: Filter, _navigationItemTaskData: Array)
Parameters :
Name Type Optional
_searchService SearchService No
_logger LoggerService No
_dialogService DialogService No
_translate TranslateService No
_allowedNetsService AllowedNetsService No
_viewIdService ViewIdService No
_searchCategories Array<Type<Category<any>>> No
_configuration SearchComponentConfiguration No
_filtersFilter Filter No
_navigationItemTaskData Array<DataGroup> No

Inputs

disabled
Type : boolean
initialSearchMode
Type : SearchMode
showAdvancedSearchHelp
Type : boolean
showLoadFilterButton
Type : boolean
showSaveFilterButton
Type : boolean
showSearchIcon
Type : boolean
showSearchToggleButton
Type : boolean

Methods

Public hasPredicates
hasPredicates()
Returns : boolean
ngOnInit
ngOnInit()
Returns : void
Public showHelp
showHelp()
Returns : void
Public toggleSearchMode
toggleSearchMode()
Returns : void

Properties

Public advancedSearchDisplayed

Accessors

showSearchIcon
getshowSearchIcon()
setshowSearchIcon(value: boolean)
Parameters :
Name Type Optional
value boolean No
Returns : void
showAdvancedSearchHelp
getshowAdvancedSearchHelp()
setshowAdvancedSearchHelp(value: boolean)
Parameters :
Name Type Optional
value boolean No
Returns : void
showSaveFilterButton
getshowSaveFilterButton()
setshowSaveFilterButton(value: boolean)
Parameters :
Name Type Optional
value boolean No
Returns : void
showLoadFilterButton
getshowLoadFilterButton()
setshowLoadFilterButton(value: boolean)
Parameters :
Name Type Optional
value boolean No
Returns : void
initialSearchMode
getinitialSearchMode()
setinitialSearchMode(value: SearchMode)
Parameters :
Name Type Optional
value SearchMode No
Returns : void
showSearchToggleButton
getshowSearchToggleButton()
setshowSearchToggleButton(value: boolean)
Parameters :
Name Type Optional
value boolean No
Returns : void
import {SearchService} from '../search-service/search.service';
import {LoggerService} from '../../logger/services/logger.service';
import {DialogService} from '../../dialog/services/dialog.service';
import {TranslateService} from '@ngx-translate/core';
import {NAE_SEARCH_COMPONENT_CONFIGURATION} from '../models/component-configuration/search-component-configuration-injection-token';
import {Component, EventEmitter, Inject, Input, OnInit, Optional, Output, Type} from '@angular/core';
import {SearchComponentConfiguration} from '../models/component-configuration/search-component-configuration';
import {SearchMode} from '../models/component-configuration/search-mode';
import {AllowedNetsService} from '../../allowed-nets/services/allowed-nets.service';
import {NAE_SEARCH_CATEGORIES} from '../category-factory/search-categories-injection-token';
import {Category} from '../models/category/category';
import {ViewIdService} from '../../user/services/view-id.service';
import {NAE_FILTERS_FILTER} from '../../filter/models/filters-filter-injection-token';
import {Filter} from '../../filter/models/filter';
import {NAE_NAVIGATION_ITEM_TASK_DATA} from '../../navigation/model/filter-case-injection-token';
import {DataGroup} from '../../resources/interface/data-groups';

/**
 * A universal search component that can be used to interactively create search predicates for anything with supported categories.
 *
 * This component is responsible for the interactive creation of an AND {@link ClausePredicate} object instance.
 * The nested Predicates are OR {@link ClausePredicate} instances created by {@link AbstractSearchClauseComponent}.
 *
 * Search categories must be provided by the {@link NAE_SEARCH_CATEGORIES} injection token.
 * Default factory methods for [task]{@link defaultTaskSearchCategoriesFactory} and
 * [case]{@link defaultCaseSearchCategoriesFactory} search categories exist. See their documentation for more information.
 *
 * The search component's visuals can be configured either by the {@link NAE_SEARCH_COMPONENT_CONFIGURATION} injection token,
 * or by the appropriate component inputs. The injection token configuration takes precedence over the inputs if both are present.
 */
@Component({
    selector: 'ncc-abstract-search',
    template: ''
})
export abstract class AbstractSearchComponent implements SearchComponentConfiguration, OnInit {

    public advancedSearchDisplayed;

    private _showSearchIcon = true;
    private _showSearchToggleButton = true;
    private _showAdvancedSearchHelp = true;
    private _showSaveFilterButton = true;
    private _showLoadFilterButton = true;
    private _initialSearchMode = SearchMode.FULLTEXT;

    @Input() public disabled: boolean;

    protected constructor(protected _searchService: SearchService,
                          protected _logger: LoggerService,
                          protected _dialogService: DialogService,
                          protected _translate: TranslateService,
                          protected _allowedNetsService: AllowedNetsService,
                          protected _viewIdService: ViewIdService,
                          @Inject(NAE_SEARCH_CATEGORIES) protected _searchCategories: Array<Type<Category<any>>>,
                          @Optional() @Inject(NAE_SEARCH_COMPONENT_CONFIGURATION) protected _configuration: SearchComponentConfiguration,
                          @Optional() @Inject(NAE_FILTERS_FILTER) protected _filtersFilter: Filter = null,
                          @Optional() @Inject(NAE_NAVIGATION_ITEM_TASK_DATA) protected _navigationItemTaskData: Array<DataGroup> = null) {
        if (this._configuration === null) {
            this._configuration = {};
        }
    }

    ngOnInit(): void {
        this.advancedSearchDisplayed = this.initialSearchMode === SearchMode.ADVANCED;
    }

    get showSearchIcon(): boolean {
        return this._configuration.showSearchIcon ?? this._showSearchIcon;
    }

    @Input() set showSearchIcon(value: boolean) {
        this._showSearchIcon = value;
    }

    get showAdvancedSearchHelp(): boolean {
        return this._configuration.showAdvancedSearchHelp ?? this._showAdvancedSearchHelp;
    }

    @Input() set showAdvancedSearchHelp(value: boolean) {
        this._showAdvancedSearchHelp = value;
    }

    get showSaveFilterButton(): boolean {
        return this._configuration.showSaveFilterButton ?? this._showSaveFilterButton;
    }

    @Input() set showSaveFilterButton(value: boolean) {
        this._showSaveFilterButton = value;
    }

    get showLoadFilterButton(): boolean {
        return this._configuration.showLoadFilterButton ?? this._showLoadFilterButton;
    }

    @Input() set showLoadFilterButton(value: boolean) {
        this._showLoadFilterButton = value;
    }

    get initialSearchMode(): SearchMode {
        return this._configuration.initialSearchMode ?? this._initialSearchMode;
    }

    @Input() set initialSearchMode(value: SearchMode) {
        this._initialSearchMode = value;
    }

    get showSearchToggleButton(): boolean {
        return this._configuration.showSearchToggleButton ?? this._showSearchToggleButton;
    }

    @Input() set showSearchToggleButton(value: boolean) {
        this._showSearchToggleButton = value;
    }

    public hasPredicates(): boolean {
        return Array.from(this._searchService.rootPredicate.getPredicateMap().values()).some(value => value.isVisible);
    }

    public toggleSearchMode(): void {
        if (this.advancedSearchDisplayed) {
            this._searchService.clearPredicates();
        } else {
            this._searchService.clearFullTextFilter();
        }

        this.advancedSearchDisplayed = !this.advancedSearchDisplayed;
    }

    public showHelp(): void {
        this._dialogService.openAlertDialog(this._translate.instant('search.help.title'), this._translate.instant('search.help.text'));
    }
}
Legend
Html element
Component
Html element with directive

results matching ""

    No results matching ""