Class: ToggleLabel

Defined in: src/sdk/fmc/components/ToggleLabel.ts:19

A field for displaying a toggle label.

Extends

• EditableField<boolean, boolean>

Constructors

Constructor

new ToggleLabel(page, options): ToggleLabel

Defined in: src/sdk/fmc/components/ToggleLabel.ts:24

Parameters

Parameter	Type
page	AbstractFmcPage
options	Partial<ToggleLabelOptions>

Returns

ToggleLabel

Inherit Doc

Overrides

EditableField.constructor

Properties

isDisabled()

isDisabled: () => boolean

Defined in: src/sdk/fmc/components/FmcComponent.ts:57

Returns

boolean

Inherited from

EditableField.isDisabled

---

options

protected options: ToggleLabelOptions

Defined in: src/sdk/fmc/components/ToggleLabel.ts:20

Overrides

EditableField.options

---

page

protected page: AbstractFmcPage

Defined in: src/sdk/fmc/components/EditableField.ts:36

Inherited from

EditableField.page

---

value

protected value: boolean | null = null

Defined in: src/sdk/fmc/components/DisplayField.ts:30

Inherited from

EditableField.value

---

valueChanged

protected readonly valueChanged: SubEvent<EditableField<boolean, boolean>, boolean>

Defined in: src/sdk/fmc/components/EditableField.ts:32

Inherited from

EditableField.valueChanged

Accessors

rawValue

Get Signature

get protected rawValue(): T | null

Defined in: src/sdk/fmc/components/DisplayField.ts:36

Gets the raw value of this display field

Returns

T | null

the value

Inherited from

EditableField.rawValue

Methods

bind()

bind(subscribable): this

Defined in: src/sdk/fmc/components/EditableField.ts:47

Binds the input field to a mutable subscribable.

Parameters

Parameter	Type	Description
subscribable	Subscribable<boolean> | MutableSubscribable<boolean, boolean>	the mutable subscribable

Returns

this

the instance of this EditableField

Inherited from

EditableField.bind

---

bindConsumer()

bindConsumer(consumer, modifier): this

Defined in: src/sdk/fmc/components/EditableField.ts:63

Binds the input field to a Consumer.

Parameters

Parameter	Type	Description
consumer	Consumer<boolean>	the consumer to bind to (get)
modifier	(value) => void	the modifier to use when the value is modified (set)

Returns

this

the instance of this EditableField

Inherited from

EditableField.bindConsumer

---

bindSource()

bindSource(source): this

Defined in: src/sdk/fmc/components/EditableField.ts:72

Binds the input field to a data interface.

Parameters

Parameter	Type	Description
source	DataInterface<boolean, boolean>	the data interface

Returns

this

the instance of this EditableField

Inherited from

EditableField.bindSource

---

getOptions()

getOptions(): DisplayFieldOptions

Defined in: src/sdk/fmc/components/FmcComponent.ts:124

Returns the component's options

Returns

DisplayFieldOptions

The options.

Inherited from

EditableField.getOptions

---

handleSelectKey()

handleSelectKey(event): Promise<string | boolean>

Defined in: src/sdk/fmc/components/FmcComponent.ts:80

Parameters

Parameter	Type
event	LineSelectKeyEvent

Returns

Promise<string | boolean>

Inherit Doc

Inherited from

EditableField.handleSelectKey

---

invalidate()

protected invalidate(): void

Defined in: src/sdk/fmc/components/FmcComponent.ts:69

Invalidates the component and queues a re-render if one is not already queued

Returns

void

Inherited from

EditableField.invalidate

---

onHandleSelectKey()

protected onHandleSelectKey(): Promise<boolean>

Defined in: src/sdk/fmc/components/ToggleLabel.ts:42

Returns

Promise<boolean>

Inherit Doc

Overrides

EditableField.onHandleSelectKey

---

render()

render(): string

Defined in: src/sdk/fmc/components/ToggleLabel.ts:36

Renders the FMC component into an FmcRenderTemplateRow

Returns

string

Overrides

EditableField.render

---

takeValue()

takeValue(value, shouldInvalidate): void

Defined in: src/sdk/fmc/components/DisplayField.ts:61

Takes an input value, displays it and stores it

Parameters

Parameter	Type	Default value	Description
value	boolean | null	undefined	the new input value
shouldInvalidate	boolean	false	whether or not to invalidate the page

Returns

void

Inherited from

EditableField.takeValue