Class: FmcScratchpad

Scratchpad for an FMC screen

Constructors

constructor

• new FmcScratchpad(bus, options, renderCallback): FmcScratchpad

Ctor

Parameters

Name	Type	Description
bus	EventBus	the event bus
options	Partial<FmcScratchpadOptions>	the options
renderCallback	FmcRenderCallback	the render callback

Returns

FmcScratchpad

Defined in

src/sdk/fmc/FmcScratchpad.ts:59

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

Deletes the last character on the scratchpad

Returns

void

Defined in

src/sdk/fmc/FmcScratchpad.ts:85

---

clear

▸ clear(clearError?): void

Clears the scratchpad

Parameters

Name	Type	Default value	Description
clearError	boolean	true	whether to clear any scratchpad error content, defaults to true

Returns

void

Defined in

src/sdk/fmc/FmcScratchpad.ts:98

---

clearError

▸ clearError(): void

Clears the scratchpad error

Returns

void

Defined in

src/sdk/fmc/FmcScratchpad.ts:111

---

delete

▸ delete(value?, clearError?): void

Sets the scratchpad in DELETE mode (or not)

Parameters

Name	Type	Default value	Description
value?	boolean	undefined	optional value to force, otherwise the value is set to true
clearError	boolean	true	whether to clear any scratchpad error content, defaults to true

Returns

void

Defined in

src/sdk/fmc/FmcScratchpad.ts:134

---

error

▸ error(error): void

Sets the scratchpad to an error message

Parameters

Name	Type	Description
error	string	The error message

Returns

void

Defined in

src/sdk/fmc/FmcScratchpad.ts:119

---

typeContents

▸ typeContents(char): void

Appends a string on the scratchpad

Parameters

Name	Type	Description
char	string	the string to append

Returns

void

Defined in

src/sdk/fmc/FmcScratchpad.ts:73