Class KmtIdleState

The idle state of the keyboard mouse and trackpad input state machine.

Hierarchy (View Summary)

TemplateState<
    KmtInputEventMapping,
    KmtInputContext,
    KmtIdleStatePossibleTargetStates,
>
- KmtIdleState

Index

Constructors

constructor

new KmtIdleState(): KmtIdleState
Returns KmtIdleState
Overrides TemplateState.constructor
- Defined in input-state-machine/kmt-input-state-machine.ts:92

Properties

`Protected`_eventGuards

_eventGuards: Partial<
    EventGuards<
        KmtInputEventMapping,
        KmtIdleStatePossibleTargetStates,
        KmtInputContext,
        Guard<KmtInputContext>,
    >,
> = {}

`Protected`_guards

_guards: Guard<KmtInputContext, "isIdle"> = { isIdle: () => true, }

Accessors

eventGuards

get eventGuards(): Partial<
    EventGuards<
        EventPayloadMapping,
        States,
        Context,
        Guard<Context, string>,
    >,
>
Returns Partial<
    EventGuards<
        EventPayloadMapping,
        States,
        Context,
        Guard<Context, string>,
    >,
>
Inherited from TemplateState.eventGuards
- Defined in being/interfaces.ts:240

eventReactions

get eventReactions(): EventReactions<
    KmtInputEventMapping,
    KmtInputContext,
    KmtIdleStatePossibleTargetStates,
>
Returns EventReactions<
    KmtInputEventMapping,
    KmtInputContext,
    KmtIdleStatePossibleTargetStates,
>
Overrides TemplateState.eventReactions
- Defined in input-state-machine/kmt-input-state-machine.ts:103

guards

get guards(): Guard<Context>
Returns Guard<Context>
Inherited from TemplateState.guards
- Defined in being/interfaces.ts:236

Methods

handles

handles<K extends keyof KmtInputEventMapping>(
    event: K,
    payload: KmtInputEventMapping[K],
    context: KmtInputContext,
): KmtIdleStatePossibleTargetStates
Type Parameters
- K extends keyof KmtInputEventMapping
Parameters
- event: K
- payload: KmtInputEventMapping[K]
- context: KmtInputContext
Returns KmtIdleStatePossibleTargetStates
Inherited from TemplateState.handles
- Defined in being/interfaces.ts:252

middlePointerDownHandler

middlePointerDownHandler(
context: KmtInputContext,
payload: PointerEventPayload,
): void
Parameters
- context: KmtInputContext
- payload: PointerEventPayload
Returns void
- Defined in input-state-machine/kmt-input-state-machine.ts:152

scrollHandler

scrollHandler(context: KmtInputContext, payload: ScrollEventPayload): void
Parameters
- context: KmtInputContext
- payload: ScrollEventPayload
Returns void
- Defined in input-state-machine/kmt-input-state-machine.ts:126

scrollWithCtrlHandler

scrollWithCtrlHandler(
context: KmtInputContext,
payload: ScrollWithCtrlEventPayload,
): void
Parameters
- context: KmtInputContext
- payload: ScrollWithCtrlEventPayload
Returns void
- Defined in input-state-machine/kmt-input-state-machine.ts:134

spacebarDownHandler

spacebarDownHandler(context: KmtInputContext, payload: EmptyPayload): void
Parameters
- context: KmtInputContext
- payload: EmptyPayload
Returns void
- Defined in input-state-machine/kmt-input-state-machine.ts:148

uponEnter

uponEnter(context: KmtInputContext): void
Parameters
- context: KmtInputContext
Returns void
Inherited from TemplateState.uponEnter
- Defined in being/interfaces.ts:244

uponLeave

uponLeave(context: KmtInputContext): void
Parameters
- context: KmtInputContext
Returns void
Inherited from TemplateState.uponLeave
- Defined in being/interfaces.ts:248

Class KmtIdleState

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns KmtIdleState

Properties

Protected_eventGuards

Protected_guards

Accessors

eventGuards

Returns Partial< EventGuards< EventPayloadMapping, States, Context, Guard<Context, string>, >,>

eventReactions

Returns EventReactions< KmtInputEventMapping, KmtInputContext, KmtIdleStatePossibleTargetStates,>

guards

Returns Guard<Context>

Methods

handles

Type Parameters

Parameters

Returns KmtIdleStatePossibleTargetStates

middlePointerDownHandler

Parameters

Returns void

scrollHandler

Parameters

Returns void

scrollWithCtrlHandler

Parameters

Returns void

spacebarDownHandler

Parameters

Returns void

uponEnter

Parameters

Returns void

uponLeave

Parameters

Returns void

Settings

On This Page

`Protected`_eventGuards

`Protected`_guards

Returns Partial<
EventGuards<
EventPayloadMapping,
States,
Context,
Guard<Context, string>,
>,
>

Returns EventReactions<
KmtInputEventMapping,
KmtInputContext,
KmtIdleStatePossibleTargetStates,
>