Class: PageLinkField
Defined in: src/sdk/fmc/components/PageLinkField.ts:19
A field for displaying a link to navigate to another page
Extends
DisplayField
<string
>
Constructors
Constructor
protected
new PageLinkField(page
,options
):PageLinkField
Defined in: src/sdk/fmc/components/PageLinkField.ts:21
Parameters
Parameter | Type |
---|---|
page | AbstractFmcPage |
options | PageLinkFieldOptions |
Returns
PageLinkField
Inherit Doc
Overrides
Properties
isDisabled()
isDisabled: () =>
boolean
Defined in: src/sdk/fmc/components/FmcComponent.ts:57
Returns
boolean
Inherited from
options
protected
options:DisplayFieldOptions
<string
>
Defined in: src/sdk/fmc/components/DisplayField.ts:41
Inherited from
page
protected
readonly
page:AbstractFmcPage
Defined in: src/sdk/fmc/components/FmcComponent.ts:61
Inherited from
value
protected
value:null
|string
=null
Defined in: src/sdk/fmc/components/DisplayField.ts:30
Inherited from
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
Inherited from
Methods
bind()
bind(
subscribable
):DisplayField
<string
>
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 <string > | the subscribable to bind to |
Returns
DisplayField
<string
>
the created binding (usually not needed)
Inherited from
getOptions()
getOptions():
DisplayFieldOptions
Defined in: src/sdk/fmc/components/FmcComponent.ts:124
Returns the component's options
Returns
The options.
Inherited from
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
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
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
Inherited from
DisplayField
.onHandleSelectKey
render()
render():
FmcFormatterOutput
Defined in: src/sdk/fmc/components/DisplayField.ts:74
Renders the FMC component into an FmcRenderTemplateRow
Returns
Inherited from
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 | string | undefined | the new input value |
shouldInvalidate | boolean | false | whether or not to invalidate the page |
Returns
void
Inherited from
createLink()
static
createLink(page
,label
,route
,disabled
,params?
):PageLinkField
Defined in: src/sdk/fmc/components/PageLinkField.ts:42
Creates an PageLinkField
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
page | AbstractFmcPage | undefined | the parent FmcPage |
label | string | undefined | the label to display |
route | string | undefined | the route to navigate to (will disable link when empty) |
disabled | boolean | false | whether the link is disabled |
params? | Record <string , unknown > | undefined | Parameters for the route |
Returns
PageLinkField
the PageLinkField