Class: List

The List component.

Hierarchy

• UiControlGroup<ListProps>

  ↳ List

Constructors

constructor

• new List(props): List

Parameters

Name	Type
props	ListProps

Returns

List

Inherit Doc

Inherited from

UiControlGroup.constructor

Defined in

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

Properties

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

UiControlGroup.context

Defined in

sdk/components/FSComponent.ts:64

---

contextType

• Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Inherited from

UiControlGroup.contextType

Defined in

sdk/components/FSComponent.ts:67

---

focusSubject

• Protected focusSubject: Subject<boolean>

Inherited from

UiControlGroup.focusSubject

Defined in

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

---

props

• props: ListProps & ComponentProps

The properties of the component.

Inherited from

UiControlGroup.props

Defined in

sdk/components/FSComponent.ts:61

---

scrollController

• Protected scrollController: ScrollController

Inherited from

UiControlGroup.scrollController

Defined in

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

Methods

blur

▸ blur(): void

Method to unfocus this control group

Returns

void

Inherited from

UiControlGroup.blur

Defined in

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

---

destroy

▸ destroy(): void

Destroys this component.

Returns

void

Inherited from

UiControlGroup.destroy

Defined in

sdk/components/FSComponent.ts:98

---

ensureIndexInView

▸ ensureIndexInView(index): void

Ensures an indexed list item is in view.

Parameters

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

Returns

void

Defined in

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

---

focus

▸ focus(dir?): void

Method to focus this control group

Parameters

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

Returns

void

Inherited from

UiControlGroup.focus

Defined in

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

---

getContext

▸ getContext(context): never

Gets a context data subscription from the context collection.

Parameters

Name	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

Defined in

sdk/components/FSComponent.ts:106

---

getHighlightElement

▸ getHighlightElement(): null | Element

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

Defined in

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

---

getIsFocusable

▸ getIsFocusable(): boolean

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

Returns

boolean

true

Inherited from

UiControlGroup.getIsFocusable

Defined in

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

---

getIsFocused

▸ getIsFocused(): boolean

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

Defined in

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

---

getListItemIndex

▸ getListItemIndex(nodeInstance): number

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

Parameters

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

Returns

number

list item index

Defined in

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

---

getListItemInstance

▸ getListItemInstance<T>(index): null | T

Gets the instance of the node at the specified index.

Type parameters

Name
T

Parameters

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

Returns

null | T

The node instance of specified type.

Defined in

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

---

getSelectedElement

▸ getSelectedElement(): null | HTMLElement

Get the selected HTMLElement.

Returns

null | HTMLElement

The selected element, if found.

Defined in

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

---

getSelectedIndex

▸ getSelectedIndex(): number

Gets the index of the currently selected element.

Returns

number

Selected element index. Returns -1 if nothing found.

Defined in

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

---

getSelectedItem

▸ getSelectedItem(): any

Gets the data object related to the selected DOM element.

Returns

any

The selected item, if found.

Defined in

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

---

onAfterRender

▸ onAfterRender(): void

A callback that is called after the component is rendered.

Returns

void

Overrides

UiControlGroup.onAfterRender

Defined in

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

---

onBeforeRender

▸ onBeforeRender(): void

Returns

void

Inherit Doc

Inherited from

UiControlGroup.onBeforeRender

Defined in

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

---

onBlurred

▸ onBlurred(): void

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

Returns

void

Overrides

UiControlGroup.onBlurred

Defined in

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

---

onFocused

▸ onFocused(): void

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

Returns

void

Inherited from

UiControlGroup.onFocused

Defined in

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

---

onInteractionEvent

▸ onInteractionEvent(evt): boolean

Handler for interaction events to be handled by the view.

Parameters

Name	Type	Description
evt	FmsHEvent	The HEvenet.

Returns

boolean

true if the event was handled in this group

Inherited from

UiControlGroup.onInteractionEvent

Defined in

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

---

onScroll

▸ onScroll(ctrl): void

Parameters

Name	Type
ctrl	ScrollableControl

Returns

void

Inherit Doc

Defined in

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

---

onScrollToggled

▸ onScrollToggled(enabled): void

A method called when the control group scroll is toggled.

Parameters

Name	Type	Description
enabled	boolean	if the scroll is enabled.

Returns

void

Inherited from

UiControlGroup.onScrollToggled

Defined in

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

---

processHEvent

▸ processHEvent(evt): boolean

Handles HEvents and routes them to the subdialog when existant.

Parameters

Name	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

Defined in

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

---

processScrollEvent

▸ processScrollEvent(evt): boolean

Attempts to handle scroll events.

Parameters

Name	Type	Description
evt	FmsHEvent	The received event.

Returns

boolean

whether the event was handled.

Inherited from

UiControlGroup.processScrollEvent

Defined in

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

---

register

▸ register(ctrl, unregister?): void

Register/Unregisters a UiControl with the scroll controller.

Parameters

Name	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

Defined in

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

---

render

▸ render(): VNode

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

UiControlGroup.render

Defined in

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

---

routeEventToControl

▸ routeEventToControl(evt, control): boolean

Routes an interaction event to a UiControl.

Parameters

Name	Type	Description
evt	FmsHEvent	An interaction event.
control	UiControl<UiControlProps>	The UiControl to which to route the event.

Returns

boolean

Whether the event was handled by the UiControl.

Inherited from

UiControlGroup.routeEventToControl

Defined in

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

---

scrollToIndex

▸ scrollToIndex(index): void

Scrolls to an item.

Parameters

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

Returns

void

Defined in

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

---

setScrollEnabled

▸ setScrollEnabled(enabled): void

Sets the scroll enabled state

Parameters

Name	Type	Description
enabled	boolean	indicating if scrolling should be enabled

Returns

void

Inherited from

UiControlGroup.setScrollEnabled

Defined in

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

---

toggleScroll

▸ toggleScroll(): void

Toggles the scroll highlighting

Returns

void

Inherited from

UiControlGroup.toggleScroll

Defined in

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