File

projects/netgrif-components-core/src/lib/tabs/classes/opened-tab.ts

Description

Holds the information of tab opened in a tab view.

See TabView for more information.

Implements

TabContent

Index

Properties
Methods

Constructor

constructor(tabContent: TabContent, uniqueId: string)
Parameters :
Name Type Optional Description
tabContent TabContent No
  • content of the tab
uniqueId string No
  • unique identifier for the tab

Properties

Protected _label$
Type : TabLabelStream
Public canBeClosed
Type : boolean
Public initial
Default value : false
Public injectedObject
Type : object
Default value : {}
Public isTabInitialized
Default value : false

Whether the tab was initialized after it's creation.

See TabGroup.initializeTab() for more information.

Public label
Type : TabLabel
Public order
Type : number
Default value : 0
Public parentUniqueId
Default value : undefined
Public portal
Type : ComponentPortal<any>

Reference to the component portal that is used to display the tab content

Public tabClosed$
Type : Subject<void>

A stream that is injected into each tab and is used to inform the tab about its termination

Public tabContentComponent
Type : Type<any>
Public tabSelected$
Type : BehaviorSubject<boolean>

A stream that is injected into each tab and is used to inform that tab whenever it is selected or deselected

Public uniqueId
Type : string
- unique identifier for the tab

Methods

Public destroy
destroy()

Closes the stream held in this object

Returns : void
Public getIcon
getIcon()
Returns : string | undefined
Public getIcon$
getIcon$()
Returns : Observable<string>
Public getText$
getText$()
Returns : Observable<string>
Public setIcon
setIcon(icon: string)
Parameters :
Name Type Optional
icon string No
Returns : void
Public setText
setText(text: string)
Parameters :
Name Type Optional
text string No
Returns : void
import {TabContent, TabLabel} from '../interfaces';
import {ComponentPortal} from '@angular/cdk/portal';
import {Type} from '@angular/core';
import {BehaviorSubject, Observable, Subject} from 'rxjs';
import {TabLabelStream} from './tab-label-stream';

/**
 * Holds the information of tab opened in a tab view.
 *
 * See {@link TabView} for more information.
 */
export class OpenedTab implements TabContent {

    /**
     * See {@link TabContent#label}.
     */
    public label: TabLabel;
    /**
     * See [TabContent.canBeClosed]{@link TabContent#canBeClosed}.
     */
    public canBeClosed: boolean;
    /**
     * See [TabContent.tabContentComponent]{@link TabContent#tabContentComponent}.
     */
    public tabContentComponent: Type<any>;
    /**
     * See [TabContent.injectedObject]{@link TabContent#injectedObject}.
     */
    public injectedObject: object = {};
    /**
     * See [TabContent.order]{@link TabContent#order}.
     */
    public order = 0;
    /**
     * See [TabContent.initial]{@link TabContent#initial}.
     */
    public initial = false;
    /**
     * See [TabContent.parentUniqueId]{@link TabContent#parentUniqueId}.
     */
    public parentUniqueId = undefined;
    /**
     * Reference to the component portal that is used to display the tab content
     */
    public portal: ComponentPortal<any>;
    /**
     * Whether the tab was initialized after it's creation.
     *
     * See [TabGroup.initializeTab()]{@link TabView#initializeTab} for more information.
     */
    public isTabInitialized = false;
    /**
     * A stream that is injected into each tab and is used to inform that tab whenever it is selected or deselected
     */
    public tabSelected$: BehaviorSubject<boolean>;
    /**
     * A stream that is injected into each tab and is used to inform the tab about its termination
     */
    public tabClosed$: Subject<void>;

    protected _label$: TabLabelStream;

    /**
     * @param tabContent - content of the tab
     * @param uniqueId - unique identifier for the tab
     */
    constructor(tabContent: TabContent, public uniqueId: string) {
        Object.assign(this, tabContent);
        this.tabSelected$ = new BehaviorSubject<boolean>(false);
        this.tabClosed$ = new Subject();
        this._label$ = new TabLabelStream(this.label?.icon, this.label?.text)
    }

    public setIcon(icon: string) {
        this._label$.icon$.next(icon);
    }

    public setText(text: string) {
        this._label$.text$.next(text);
    }

    public getIcon$(): Observable<string> {
        return this._label$.icon$.asObservable();
    }

    public getIcon(): string | undefined {
        return this._label$.icon$.getValue();
    }

    public getText$(): Observable<string> {
        return this._label$.text$.asObservable();
    }

    /**
     * Closes the stream held in this object
     */
    public destroy(): void {
        this.tabSelected$.complete();
        this.tabClosed$.complete();
        this._label$.destroy()
    }
}

results matching ""

    No results matching ""