Class: List

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/List.tsx:29

The List component.

Extends

• UiControlGroup<ListProps>

Constructors

Constructor

new List(props): List

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:36

Parameters

Parameter	Type
props	ListProps

Returns

List

Inherit Doc

Inherited from

UiControlGroup.constructor

Properties

context?

optional context: [] = undefined

Defined in: sdk/components/FSComponent.ts:64

The context on this component, if any.

Inherited from

UiControlGroup.context

---

contextType?

readonly optional contextType: readonly [] = undefined

Defined in: sdk/components/FSComponent.ts:67

The type of context for this component, if any.

Inherited from

UiControlGroup.contextType

---

focusSubject

protected focusSubject: Subject<boolean>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:33

Inherited from

UiControlGroup.focusSubject

---

props

props: ListProps & ComponentProps

Defined in: sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from

UiControlGroup.props

---

scrollController

protected scrollController: ScrollController

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:32

Inherited from

UiControlGroup.scrollController

Methods

blur()

blur(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:71

Method to unfocus this control group

Returns

void

Inherited from

UiControlGroup.blur

---

destroy()

destroy(): void

Defined in: sdk/components/FSComponent.ts:98

Destroys this component.

Returns

void

Inherited from

UiControlGroup.destroy

---

ensureIndexInView()

ensureIndexInView(index): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/List.tsx:178

Ensures an indexed list item is in view.

Parameters

Parameter	Type	Description
index	number	The index of the list item.

Returns

void

---

focus()

focus(dir): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:61

Method to focus this control group

Parameters

Parameter	Type	Default value	Description
dir	EntryDirection	'top'	The direction of entry.

Returns

void

Inherited from

UiControlGroup.focus

---

getContext()

protected getContext(context): never

Defined in: sdk/components/FSComponent.ts:106

Gets a context data subscription from the context collection.

Parameters

Parameter	Type	Description
context	never	The context to get the subscription for.

Returns

never

The requested context.

Throws

An error if no data for the specified context type could be found.

Inherited from

UiControlGroup.getContext

---

getHighlightElement()

getHighlightElement(): null | Element

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:125

This is just a dummy that exists here to be compatible with the union type of ScrollableControl

Returns

null | Element

null

Inherited from

UiControlGroup.getHighlightElement

---

getIsFocusable()

getIsFocusable(): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:88

Gets a boolean indicating if this control is able to be focused.

Returns

boolean

true

Inherited from

UiControlGroup.getIsFocusable

---

getIsFocused()

getIsFocused(): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:80

Method to check if this UiControlGroup is in focus

Returns

boolean

true if the control group is in focus, false otherwise

Inherited from

UiControlGroup.getIsFocused

---

getListItemIndex()

getListItemIndex(nodeInstance): number

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/List.tsx:228

Gets index of a item in the list by its node instance.

Parameters

Parameter	Type	Description
nodeInstance	ScrollableControl	The node instance to look for.

Returns

number

list item index

---

getListItemInstance()

getListItemInstance<T>(index): null | T

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/List.tsx:219

Gets the instance of the node at the specified index.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
index	number	The index to get the instance for.

Returns

null | T

The node instance of specified type.

---

getSelectedElement()

getSelectedElement(): null | HTMLElement

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/List.tsx:201

Get the selected HTMLElement.

Returns

null | HTMLElement

The selected element, if found.

---

getSelectedIndex()

getSelectedIndex(): number

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/List.tsx:209

Gets the index of the currently selected element.

Returns

number

Selected element index. Returns -1 if nothing found.

---

getSelectedItem()

getSelectedItem(): any

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/List.tsx:189

Gets the data object related to the selected DOM element.

Returns

any

The selected item, if found.

---

onAfterRender()

onAfterRender(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/List.tsx:37

A callback that is called after the component is rendered.

Returns

void

Overrides

UiControlGroup.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:51

Returns

void

Inherit Doc

Inherited from

UiControlGroup.onBeforeRender

---

onBlurred()

protected onBlurred(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/List.tsx:233

A callback which is called when this control group is blurred.

Returns

void

Overrides

UiControlGroup.onBlurred

---

onFocused()

protected onFocused(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:237

A callback which is called when this control group is focused.

Returns

void

Inherited from

UiControlGroup.onFocused

---

onInteractionEvent()

onInteractionEvent(evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:217

Handler for interaction events to be handled by the view.

Parameters

Parameter	Type	Description
evt	FmsHEvent	The HEvenet.

Returns

boolean

true if the event was handled in this group

Inherited from

UiControlGroup.onInteractionEvent

---

onScroll()

protected onScroll(ctrl): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/List.tsx:244

Parameters

Parameter	Type
ctrl	ScrollableControl

Returns

void

Inherit Doc

---

onScrollToggled()

protected onScrollToggled(enabled): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:97

A method called when the control group scroll is toggled.

Parameters

Parameter	Type	Description
enabled	boolean	if the scroll is enabled.

Returns

void

Inherited from

UiControlGroup.onScrollToggled

---

processHEvent()

processHEvent(evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:134

Handles HEvents and routes them to the subdialog when existant.

Parameters

Parameter	Type	Description
evt	FmsHEvent	The received event.

Returns

boolean

true if the event was handled in this control group, false otherwise.

Inherited from

UiControlGroup.processHEvent

---

processScrollEvent()

protected processScrollEvent(evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:196

Attempts to handle scroll events.

Parameters

Parameter	Type	Description
evt	FmsHEvent	The received event.

Returns

boolean

whether the event was handled.

Inherited from

UiControlGroup.processScrollEvent

---

register()

protected register(ctrl, unregister): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:226

Register/Unregisters a UiControl with the scroll controller.

Parameters

Parameter	Type	Default value	Description
ctrl	ScrollableControl	undefined	The UiControl to register.
unregister	boolean	false	Indicates if the UiControl should be unregistered.

Returns

void

Inherited from

UiControlGroup.register

---

render()

render(): VNode

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/List.tsx:294

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

UiControlGroup.render

---

routeEventToControl()

protected routeEventToControl(evt, control): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:176

Routes an interaction event to a UiControl.

Parameters

Parameter	Type	Description
evt	FmsHEvent	An interaction event.
control	UiControl	The UiControl to which to route the event.

Returns

boolean

Whether the event was handled by the UiControl.

Inherited from

UiControlGroup.routeEventToControl

---

scrollToIndex()

scrollToIndex(index): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/List.tsx:170

Scrolls to an item.

Parameters

Parameter	Type	Description
index	number	is the index of the list item to scroll to.

Returns

void

---

setScrollEnabled()

setScrollEnabled(enabled): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:113

Sets the scroll enabled state

Parameters

Parameter	Type	Description
enabled	boolean	indicating if scrolling should be enabled

Returns

void

Inherited from

UiControlGroup.setScrollEnabled

---

toggleScroll()

toggleScroll(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:104

Toggles the scroll highlighting

Returns

void

Inherited from

UiControlGroup.toggleScroll