@talenra/inbox documentation
  1. Injectables
  2. KeyboardService

File

src/lib/inbox/services/keyboard.service.ts

Description

Service to handle keyboard events. Specific key are registered and propagated to the components. Specific keys are subscribable.

Index

Properties
Methods

Methods

closeAllMenus
closeAllMenus(notClose?: string)

Closes all mat-menus, attribute-settings and action menu.

Parameters :
Name Type Optional Description
notClose string Yes

The menu that should not be closed.
Returns : void
Public createSubscriptions
createSubscriptions()

Creates the subscriptions.

Returns : void
getNextDataItemIndex
getNextDataItemIndex(index: number, direction: number)

Get the next possible selected data item. If returned -2 the next data item is not selectable.

Parameters :
Name Type Optional Description
index number No

The index of the current selected data item.
direction number No

The direction of the next data item (1 = down, -1 = up).
Returns : number
handleSidePanel
handleSidePanel(tab: string)

Opens or closes the side panel and sets the correct tab.

Parameters :
Name Type Optional Description
tab string No

The tab to open or close.
Returns : void
keyDownEvent
keyDownEvent(event: KeyboardEvent)

Registers key click and propagate to components.

Parameters :
Name Type Optional Description
event KeyboardEvent No

Clicked Key.
Returns : void
keyUpEvent
keyUpEvent(event: KeyboardEvent)

Registers key click and propagate to components.

Parameters :
Name Type Optional Description
event KeyboardEvent No

Clicked Key.
Returns : void

Properties

Public Readonly arrowLeftKeyPressed
Type : BehaviorSubject<boolean>
Default value : new BehaviorSubject<boolean>(false)

Determines whether arrowLeft key is pressed.
Public Readonly arrowRightKeyPressed
Type : BehaviorSubject<boolean>
Default value : new BehaviorSubject<boolean>(false)

The boolean if the arrowRight key is pressed.
Public bigDetailViewScreen
Type : BehaviorSubject<boolean>
Default value : new BehaviorSubject<boolean>(false)

The boolean if the big detail view is shown.
Optional clickedDataItemEmitter
Type : EventEmitter<any>

The clicked data item emitter to be called when a key is pressed. Passed on from the inbox component to emit the clicked data Item.
Public Readonly controlKeyPressed
Type : BehaviorSubject<boolean>
Default value : new BehaviorSubject<boolean>(false)

The boolean if the control key is pressed.
Optional dataItemsAvailable
Type : boolean

The boolean if the data items are available.
Public dataItemsClass
Type : DataItemsClass
Default value : new DataItemsClass()

Class to interact with data-items-list-data.
Optional dataItemSelectedFunction
Type : function

The data item selected function to be called when a key is pressed.
Optional dataItemsInteractions
Type : EventEmitter<IInteractedDataItems>

The data ite, interactions function to be called when a key is pressed. Passed on from the inbox component to emit the specific event.
dataItemsService
Type : unknown
Default value : inject(DataItemsService)

The public service of the data items.
Public disabledButtonNoDataItemFound
Type : unknown
Default value : false

Some icon buttons are disabled at the moment
Public Readonly enterKeyPressed
Type : BehaviorSubject<boolean>
Default value : new BehaviorSubject<boolean>(false)

The boolean if the enter key is pressed.
Public Readonly escapeKeyPressed
Type : BehaviorSubject<boolean>
Default value : new BehaviorSubject<boolean>(false)

The boolean if the escape key is pressed.
filterToolbarService
Type : unknown
Default value : inject(FilterToolbarService)

The public service of the filter toolbar.
Optional iconBtnFunction
Type : function

The icon button function to be called when a key is pressed.
inboxDetailViewService
Type : unknown
Default value : inject(InboxDetailViewService)

The public service of the inbox detail viewe.
inboxState
Type : unknown
Default value : inject(InboxState)

The state of the inbox.
inboxToolbarService
Type : unknown
Default value : inject(InboxToolbarService)

The public service of the inbox toolbar.
Optional lockedDataItems
Type : IDataItemId[]

The locked data items for the data item list.
Public Readonly metaKeyPressed
Type : BehaviorSubject<boolean>
Default value : new BehaviorSubject<boolean>(false)

The boolean if the meta key is pressed.
refreshing
Type : unknown
Default value : false

The boolean if data item list is refreshing.
Public searchedDataItems
Type : any[]
Default value : []

Data Items which are filtered by the search
Public shiftKeyPressed
Type : BehaviorSubject<boolean>
Default value : new BehaviorSubject<boolean>(false)

The boolean if the shift key is pressed.
Public subscriptions
Type : Subscription
Default value : new Subscription()

The subscriptions of the service.

results matching ""

    No results matching ""