Class CancellingState

A state of an FSM. A cancelling state cancels the FSM of a user interaction.

Hierarchy

StateBase
- CancellingState

Implements

InputState

Index

Constructors

Properties

Methods

acceptVisitor checkStartingState enter uninstall

Constructors

constructor

new CancellingState(stateMachine, stateName): CancellingState
Creates the state.
Parameters
- stateMachine: FSM
  The FSM that will contain the state.
- stateName: string
  The name of this state.
Returns CancellingState
Overrides StateBase.constructor
- Defined in impl/fsm/CancellingState.ts:31

Properties

`Readonly` fsm

fsm: FSM

The FSM that contains the state.

`Readonly` name

name: string

The name of the state.

Methods

acceptVisitor

acceptVisitor(visitor): void
Visiting the state.
Parameters
- visitor: VisitorFSM
  The visitor.
Returns void
Implementation of InputState.acceptVisitor
Overrides StateBase.acceptVisitor
- Defined in impl/fsm/CancellingState.ts:41

checkStartingState

checkStartingState(): void
Checks whether the starting state of the fsm is this state. In this case, the fsm is notified about the starting of the FSM.

Returns void
Throws
CancelFSMException
Implementation of InputState.checkStartingState
Inherited from StateBase.checkStartingState
- Defined in impl/fsm/StateBase.ts:38

enter

enter(): void
Actions done while entering this state.

Returns void
Throws
CancelFSMException If entering the state leads to a cancelling of the FSM execution.
Implementation of InputState.enter
- Defined in impl/fsm/CancellingState.ts:35

uninstall

uninstall(): void
Uninstall (ie flushes) the state. Useful to clear data. The state must not be used after that.

Returns void
Implementation of InputState.uninstall
Overrides StateBase.uninstall
- Defined in impl/fsm/CancellingState.ts:39

Generated using TypeDoc