Info

File

libs/upp-base/src/modules/view.ts

Description

including device considerations, access levels, view modes, right panel status, tab status, and service worker updates.

Index

Constructor

constructor(lang: languageService, platform: platformService, http: httpService, state: stateService, config: configService)

Dependencies: Injects services for language management (languageService), platform-specific logic (platformService), HTTP connectivity (httpService), and state management (stateService).
Device Initialization: Waits for the platform to be ready and checks the device state (e.g., kiosk mode).
Session Expiration Handling: Subscribes to session expiration events from stateService to reset the view when the session expires.
Close Request Subscription: Subscribes to close requests, incrementing a counter to track the number of subscribers who respond to close events.
Language Loading: Initiates loading of necessary language modules based on the current user access level.

Parameters :

Name	Type	Optional	Description
lang	`languageService`	No	Service responsible for managing language modules and localization.
platform	`platformService`	No	Service providing platform-specific information and state management.
http	`httpService`	No	Service for managing network connectivity and online status.
state	`stateService`	No	Service for managing user state and access level, including session expiration events.
config	`configService`	No

Methods

Async GrantViewChange

GrantViewChange()

Returns : Promise<boolean>

True if all subscribers allow the view change, otherwise false.

ngOnDestroy

ngOnDestroy()

Returns : void

OnCloseResponse

OnCloseResponse(allow: boolean)

Parameters :

Name	Type	Optional	Description
allow	`boolean`	No	Indicates whether the close request is granted.

Returns : void

Async Refresh

Refresh()

Returns : Promise<void>

SetMainTab

SetMainTab(mode: EditMode, value: string | null)

Parameters :

Name	Type	Optional
mode	`EditMode`	No
value	`string \| null`	No

Returns : void

Properties

Public OnCloseRequest

Type : object

Default value :

{
        subscribe: (callback: () => void): Subscription => {
            this._closesubscribers++;   // increments the number of subscriptors
            const subscription = this._onCloseRequest.asObservable().subscribe(callback);
            
            // override the unsubscribe method to update the subscriber counters
            const original_unsubscribe = subscription.unsubscribe;
            subscription.unsubscribe = () => {
                this._closesubscribers--;   // release the subscriptor
                original_unsubscribe.call(subscription);
            };
            
            return subscription;
        }
    }

Public OnRightChanged

Default value : this._onRightChanged.asObservable()

Public OnTabChanged

Default value : this._onTabChanged.asObservable()

Public OnViewChanged

Default value : this._onViewChanged.asObservable()

Accessors

CanZoom

getCanZoom()

Theme

getTheme()

Returns : "dark" | "light" | null

setTheme(value: "dark" | "light")

Parameters :

Name	Type	Optional
value	`"dark" \| "light"`	No

Returns : void

LightTheme

getLightTheme()

Returns : boolean

DarkTheme

getDarkTheme()

Returns : boolean

OnTheme

getOnTheme()

Returns : Observable<undefined>

Scrollbar

getScrollbar()

Returns : boolean

setScrollbar(value: boolean)

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

Mobile

getMobile()

Returns : boolean

Desktop

getDesktop()

Returns : boolean

Legacy

getLegacy()

Returns : boolean

Kiosk

getKiosk()

Returns : boolean

setKiosk(value: boolean)

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

OnKiosk

getOnKiosk()

Returns : Observable<undefined>

IsPOS

getIsPOS()

Returns : boolean

setIsPOS(value: boolean)

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

View

getView()

setView(value: ViewMode | null)

Parameters :

Name	Type	Optional
value	`ViewMode \| null`	No

Returns : void

Access

getAccess()

setAccess(value: UserMode)

Parameters :

Name	Type	Optional
value	`UserMode`	No

Returns : void

Mode

getMode()

Returns : EditMode | null

setMode(value: EditMode)

Parameters :

Name	Type	Optional
value	`EditMode`	No

Returns : void

DefaultPanel

getDefaultPanel()

Returns : string | null

setDefaultPanel(value: string | null)

Parameters :

Name	Type	Optional
value	`string \| null`	No

Returns : void

MainTab

getMainTab()

Setting a new tab will emit a change event.

Returns : string | null

ScndTab

getScndTab()

Setting a new tab will emit a change event.

Returns : string | null

setScndTab(value: string | null)

Parameters :

Name	Type	Optional
value	`string \| null`	No

Returns : void

PanelArg

getPanelArg()

Setting the tab arguments will emit a change event.

Returns : any | null

setPanelArg(value: any | null)

Parameters :

Name	Type	Optional
value	`any \| null`	No

Returns : void

Panel

getPanel()

Returns : PlacePanel | null

setPanel(value: PlacePanel | null)

Parameters :

Name	Type	Optional
value	`PlacePanel \| null`	No

Returns : void

IsOnline

getIsOnline()

OnOnline

getOnOnline()

Returns : Observable<boolean>

SwUpdate

getSwUpdate()

Returns : boolean

setSwUpdate(value: boolean)

Parameters :

Name	Type	Optional
value	`boolean`	No

Returns : void

File

Description

Index

Properties

Methods

Accessors

Constructor

Methods

Properties

Accessors

results matching ""

No results matching ""