Class KeyTransition

A transition for a keys.

Hierarchy

TransitionBase<KeyboardEvent>
- KeyTransition
  - EscapeKeyPressureTransition

Index

Constructors

Properties

acceptedEvents action guard src tgt

Accessors

Methods

accept acceptVisitor execute getAcceptedEvents uninstall

Constructors

constructor

new KeyTransition(srcState, tgtState, keyType, action?, guard?): KeyTransition
Creates the transition.
Parameters
- srcState: OutputState
  The source state of the transition
- tgtState: InputState
  The output state of the transition
- keyType: "keydown" | "keyup"
  The type of key event
- Optional action: ((evt) => void)
  The action to execute when going through the transition
  - - (evt): void
    - Parameters
      evt: KeyboardEvent
      Returns void
- Optional guard: ((evt) => boolean)
  The guard to fulfil to execute the transition
  - - (evt): boolean
    - Parameters
      evt: KeyboardEvent
      Returns boolean
Returns KeyTransition
Overrides TransitionBase.constructor
- Defined in impl/fsm/KeyTransition.ts:35

Properties

`Private` `Readonly` acceptedEvents

acceptedEvents: ReadonlySet<"input" | "auxclick" | "change" | "click" | "keydown" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "scroll" | "touchend" | "touchmove" | "touchstart" | "wheel"> = ...

`Readonly` action

action: ((evt) => void)

Type declaration

- (evt): void
- Parameters
  - evt: KeyboardEvent
  Returns void

`Readonly` guard

guard: ((evt) => boolean)

Type declaration

- (evt): boolean
- Parameters
  - evt: KeyboardEvent
  Returns boolean

`Readonly` src

src: OutputState

`Readonly` tgt

tgt: InputState

Accessors

target

get target(): InputState
The target state of the transition

Returns InputState
Inherited from TransitionBase.target
- Defined in impl/fsm/TransitionBase.ts:69

Methods

accept

accept(event): event is KeyboardEvent
Parameters
- event: Event
Returns event is KeyboardEvent
Overrides TransitionBase.accept
- Defined in impl/fsm/KeyTransition.ts:41

acceptVisitor

acceptVisitor(visitor): void
Visiting the transition.
Parameters
- visitor: VisitorFSM
  The visitor.
Returns void
Inherited from TransitionBase.acceptVisitor
- Defined in impl/fsm/TransitionBase.ts:63

execute

execute(event): undefined | InputState
Executes the transition.
Parameters
- event: Event
  The event to process.
Returns undefined | InputState
The potential output state.

Throws
CancelFSMException If the execution cancels the FSM execution.
Inherited from TransitionBase.execute
- Defined in impl/fsm/TransitionBase.ts:50

getAcceptedEvents

getAcceptedEvents(): ReadonlySet<"input" | "auxclick" | "change" | "click" | "keydown" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "scroll" | "touchend" | "touchmove" | "touchstart" | "wheel">
Returns ReadonlySet<"input" | "auxclick" | "change" | "click" | "keydown" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "scroll" | "touchend" | "touchmove" | "touchstart" | "wheel">
The set of events accepted by the transition.
Overrides TransitionBase.getAcceptedEvents
- Defined in impl/fsm/KeyTransition.ts:45

uninstall

uninstall(): void
Clean the transition when not used anymore.

Returns void
Inherited from TransitionBase.uninstall
- Defined in impl/fsm/TransitionBase.ts:73

Generated using TypeDoc