Class: FmcListUtility<T>
Defined in: src/sdk/fmc/FmcListUtility.ts:9
Utility class to drive list
Type Parameters
Type Parameter |
---|
T |
Constructors
Constructor
new FmcListUtility<
T
>(page
,data
,renderRow
,size
,firstPageSize
):FmcListUtility
<T
>
Defined in: src/sdk/fmc/FmcListUtility.ts:19
FMC List Utility Class
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
page | AbstractFmcPage | undefined | The Fmc Page |
data | SubscribableArray <T > | undefined | The row input data |
renderRow | (page , indexInDisplay , prevData? , data? , nextData? ) => FmcRenderTemplateRow [] | undefined | Function to call when the list needs to be re-rendered with new data |
size | number | 5 | row count of the list per page |
firstPageSize | undefined | number | undefined | row count of the first page of the list |
Returns
FmcListUtility
<T
>
Properties
data
protected
readonly
data:SubscribableArray
<T
>
Defined in: src/sdk/fmc/FmcListUtility.ts:21
The row input data
firstPageSize
protected
readonly
firstPageSize:undefined
|number
=undefined
Defined in: src/sdk/fmc/FmcListUtility.ts:24
row count of the first page of the list
page
protected
readonly
page:AbstractFmcPage
Defined in: src/sdk/fmc/FmcListUtility.ts:20
The Fmc Page
renderRow()
protected
readonly
renderRow: (page
,indexInDisplay
,prevData?
,data?
,nextData?
) =>FmcRenderTemplateRow
[]
Defined in: src/sdk/fmc/FmcListUtility.ts:22
Function to call when the list needs to be re-rendered with new data
Parameters
Parameter | Type |
---|---|
page | AbstractFmcPage |
indexInDisplay | number |
prevData? | T |
data? | T |
nextData? | T |
Returns
size
protected
readonly
size:number
=5
Defined in: src/sdk/fmc/FmcListUtility.ts:23
row count of the list per page
Methods
handleSelectKey()
handleSelectKey(
event
):Promise
<boolean
>
Defined in: src/sdk/fmc/FmcListUtility.ts:59
Handles when the Select Key is pressed.
Parameters
Parameter | Type | Description |
---|---|---|
event | LineSelectKeyEvent | The Select Key Event. |
Returns
Promise
<boolean
>
Whether the event was handled by this component.
renderList()
renderList(
page
):FmcRenderTemplateRow
[]
Defined in: src/sdk/fmc/FmcListUtility.ts:33
Returns a rendered list page for a specified page
Parameters
Parameter | Type | Description |
---|---|---|
page | number | The page number to render |
Returns
The FmcRenderTemplate