Class: DisplayField<T>

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

An FmcComponent for displaying values according to formats

Extends

• FmcComponent<DisplayFieldOptions<T>>

Extended by

• EditableField
• PageLinkField

Type Parameters

Type Parameter
T

Constructors

Constructor

new DisplayField<T>(page, options): DisplayField<T>

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

Parameters

Parameter	Type
page	AbstractFmcPage
options	DisplayFieldOptions<T>

Returns

DisplayField<T>

Inherit Doc

Overrides

FmcComponent.constructor

Properties

isDisabled()

isDisabled: () => boolean

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

Returns

boolean

Inherited from

FmcComponent.isDisabled

---

options

protected options: DisplayFieldOptions<T>

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

Inherited from

FmcComponent.options

---

page

protected readonly page: AbstractFmcPage

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

Inherited from

FmcComponent.page

---

value

protected value: null | T = null

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

Accessors

rawValue

Get Signature

get protected rawValue(): null | T

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

Gets the raw value of this display field

Returns

null | T

the value

Methods

bind()

bind(subscribable): DisplayField<T>

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

Creates and registers a binding on the page, linking this field with a subscribable

Parameters

Parameter	Type	Description
subscribable	Subscribable<T>	the subscribable to bind to

Returns

DisplayField<T>

the created binding (usually not needed)

---

getOptions()

getOptions(): DisplayFieldOptions

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

Returns the component's options

Returns

DisplayFieldOptions

The options.

Inherited from

FmcComponent.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

FmcComponent.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

FmcComponent.invalidate

---

onHandleSelectKey()

protected onHandleSelectKey(event): Promise<string | boolean>

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

Parameters

Parameter	Type
event	LineSelectKeyEvent

Returns

Promise<string | boolean>

Inherit Doc

Overrides

FmcComponent.onHandleSelectKey

---

render()

render(): FmcFormatterOutput

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

Renders the FMC component into an FmcRenderTemplateRow

Returns

FmcFormatterOutput

Overrides

FmcComponent.render

---

takeValue()

takeValue(value, shouldInvalidate): void

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

Takes an input value, displays it and stores it

Parameters

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

Returns

void