Skip to main content

Class: FmcScratchpad

Defined in: src/sdk/fmc/FmcScratchpad.ts:34

Scratchpad for an FMC screen

Constructors

Constructor

new FmcScratchpad(bus, options, renderCallback): FmcScratchpad

Defined in: src/sdk/fmc/FmcScratchpad.ts:59

Ctor

Parameters

ParameterTypeDescription
busEventBusthe event bus
optionsPartial<FmcScratchpadOptions>the options
renderCallbackFmcRenderCallbackthe render callback

Returns

FmcScratchpad

Properties

contents

contents: Subject<string>

Defined in: src/sdk/fmc/FmcScratchpad.ts:45


errorContents

errorContents: Subject<string>

Defined in: src/sdk/fmc/FmcScratchpad.ts:47


isInDelete

isInDelete: Subject<boolean>

Defined in: src/sdk/fmc/FmcScratchpad.ts:51


options

readonly options: Required<FmcScratchpadOptions>

Defined in: src/sdk/fmc/FmcScratchpad.ts:35


renderedText

renderedText: Subject<string>

Defined in: src/sdk/fmc/FmcScratchpad.ts:49

Methods

backspace()

backspace(): void

Defined in: src/sdk/fmc/FmcScratchpad.ts:85

Deletes the last character on the scratchpad

Returns

void


clear()

clear(clearError): void

Defined in: src/sdk/fmc/FmcScratchpad.ts:98

Clears the scratchpad

Parameters

ParameterTypeDefault valueDescription
clearErrorbooleantruewhether to clear any scratchpad error content, defaults to true

Returns

void


clearError()

clearError(): void

Defined in: src/sdk/fmc/FmcScratchpad.ts:111

Clears the scratchpad error

Returns

void


delete()

delete(value?, clearError?): void

Defined in: src/sdk/fmc/FmcScratchpad.ts:134

Sets the scratchpad in DELETE mode (or not)

Parameters

ParameterTypeDefault valueDescription
value?booleanundefinedoptional value to force, otherwise the value is set to true
clearError?booleantruewhether to clear any scratchpad error content, defaults to true

Returns

void


error()

error(error): void

Defined in: src/sdk/fmc/FmcScratchpad.ts:119

Sets the scratchpad to an error message

Parameters

ParameterTypeDescription
errorstringThe error message

Returns

void


typeContents()

typeContents(char): void

Defined in: src/sdk/fmc/FmcScratchpad.ts:73

Appends a string on the scratchpad

Parameters

ParameterTypeDescription
charstringthe string to append

Returns

void