Class ReadyToPanViaScrollWheelState

Hierarchy (View Summary)

TemplateState<BoardEventMapping, BoardContext, BoardStates>
- ReadyToPanViaScrollWheelState

Index

Constructors

Properties

_eventGuards _guards

Accessors

eventGuards eventReactions guards

Methods

handles middlePointerMoveHandler middlePointerUpHandler uponEnter uponLeave

Constructors

constructor

new ReadyToPanViaScrollWheelState(): ReadyToPanViaScrollWheelState
Returns ReadyToPanViaScrollWheelState
Overrides TemplateState.constructor
- Defined in input-state-machine/input-state-machine.ts:308

Properties

`Protected`_eventGuards

_eventGuards: Partial<
    EventGuards<
        BoardEventMapping,
        BoardStates,
        BoardContext,
        Guard<BoardContext, string>,
    >,
> = {}

`Protected`_guards

_guards: Guard<BoardContext> = {}

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:115

eventReactions

get eventReactions(): Partial<
EventAction<BoardEventMapping, BoardContext, BoardStates>,
>
Returns Partial<EventAction<BoardEventMapping, BoardContext, BoardStates>>
Overrides TemplateState.eventReactions
- Defined in input-state-machine/input-state-machine.ts:323

guards

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

Methods

handles

handles<K extends keyof BoardEventMapping>(
    stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>,
    event: K,
    payload: BoardEventMapping[K],
    context: BoardContext,
): BoardStates
Type Parameters
- K extends keyof BoardEventMapping
Parameters
- stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>
- event: K
- payload: BoardEventMapping[K]
- context: BoardContext
Returns BoardStates
Inherited from TemplateState.handles
- Defined in being/interfaces.ts:127

middlePointerMoveHandler

middlePointerMoveHandler(
    stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>,
    context: BoardContext,
    payload: PointerEventPayload,
): BoardStates
Parameters
- stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>
- context: BoardContext
- payload: PointerEventPayload
Returns BoardStates
- Defined in input-state-machine/input-state-machine.ts:327

middlePointerUpHandler

middlePointerUpHandler(
    stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>,
    context: BoardContext,
    payload: PointerEventPayload,
): BoardStates
Parameters
- stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>
- context: BoardContext
- payload: PointerEventPayload
Returns BoardStates
- Defined in input-state-machine/input-state-machine.ts:332

uponEnter

uponEnter(
stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>,
context: BoardContext,
): void
Parameters
- stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>
- context: BoardContext
Returns void
Inherited from TemplateState.uponEnter
- Defined in being/interfaces.ts:119

uponLeave

uponLeave(
stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>,
context: BoardContext,
): void
Parameters
- stateMachine: StateMachine<BoardEventMapping, BoardContext, BoardStates>
- context: BoardContext
Returns void
Inherited from TemplateState.uponLeave
- Defined in being/interfaces.ts:123