Class: ToggleLabel

A field for displaying a toggle label.

Hierarchy

• EditableField<boolean, boolean>

  ↳ ToggleLabel

Constructors

constructor

• new ToggleLabel(page, options?): ToggleLabel

Parameters

Name	Type
page	AbstractFmcPage<any>
options	Partial<ToggleLabelOptions>

Returns

ToggleLabel

Inherit Doc

Overrides

EditableField.constructor

Defined in

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

Properties

isDisabled

• isDisabled: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Inherited from

EditableField.isDisabled

Defined in

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

---

options

• Protected options: ToggleLabelOptions

Overrides

EditableField.options

Defined in

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

---

page

• Protected page: AbstractFmcPage<any>

Inherited from

EditableField.page

Defined in

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

---

value

• Protected value: null | boolean = null

Inherited from

EditableField.value

Defined in

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

---

valueChanged

• Protected Readonly valueChanged: SubEvent<EditableField<boolean, boolean>, boolean>

Inherited from

EditableField.valueChanged

Defined in

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

Accessors

rawValue

• get rawValue(): null | T

Gets the raw value of this display field

Returns

null | T

the value

Inherited from

EditableField.rawValue

Defined in

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

Methods

bind

▸ bind(subscribable): this

Binds the input field to a mutable subscribable.

Parameters

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

Returns

this

the instance of this EditableField

Inherited from

EditableField.bind

Defined in

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

---

bindConsumer

▸ bindConsumer(consumer, modifier): this

Binds the input field to a Consumer.

Parameters

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

Returns

this

the instance of this EditableField

Inherited from

EditableField.bindConsumer

Defined in

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

---

bindSource

▸ bindSource(source): this

Binds the input field to a data interface.

Parameters

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

Returns

this

the instance of this EditableField

Inherited from

EditableField.bindSource

Defined in

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

---

getOptions

▸ getOptions(): DisplayFieldOptions<boolean>

Returns the component's options

Returns

DisplayFieldOptions<boolean>

The options.

Inherited from

EditableField.getOptions

Defined in

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

---

handleSelectKey

▸ handleSelectKey(event): Promise<string | boolean>

Parameters

Name	Type
event	LineSelectKeyEvent

Returns

Promise<string | boolean>

Inherit Doc

Inherited from

EditableField.handleSelectKey

Defined in

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

---

invalidate

▸ invalidate(): void

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

Returns

void

Inherited from

EditableField.invalidate

Defined in

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

---

onHandleSelectKey

▸ onHandleSelectKey(): Promise<boolean>

Returns

Promise<boolean>

Inherit Doc

Overrides

EditableField.onHandleSelectKey

Defined in

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

---

render

▸ render(): string

Renders the FMC component into an FmcRenderTemplateRow

Returns

string

Overrides

EditableField.render

Defined in

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

---

takeValue

▸ takeValue(value, shouldInvalidate?): void

Takes an input value, displays it and stores it

Parameters

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

Returns

void

Inherited from

EditableField.takeValue

Defined in

src/sdk/fmc/components/DisplayField.ts:60