Class: G1000ControlList<T>

A component that holds lists of G1000UiControls.

Type parameters

Name
`T`

Hierarchy

HardwareUiControlList<T, FmsUiControlEvents, GarminControlListProps<T>>
↳ G1000ControlList

Implements

UiControlEventHandlers<FmsUiControlEvents>

Constructors

constructor

• new G1000ControlList<T>(props): G1000ControlList<T>

Creates an instance of a ControlList.

Type parameters

Name
`T`

Parameters

Name	Type	Description
`props`	`GarminControlListProps`<`T`>	The props on the ControlList component.

Returns

G1000ControlList<T>

Inherited from

HardwareUiControlList<T, FmsUiControlEvents, GarminControlListProps<T>>.constructor

Defined in

sdk/components/controls/HardwareUiControlList.tsx:64

Properties

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

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

HardwareUiControlList.contextType

Defined in

sdk/components/FSComponent.ts:67

focusedIndex

• Protected focusedIndex: number = -1

Inherited from

HardwareUiControlList.focusedIndex

Defined in

sdk/components/controls/HardwareUiControl.tsx:139

props

• props: GarminControlListProps<T> & ComponentProps

The properties of the component.

Inherited from

HardwareUiControlList.props

Defined in

sdk/components/FSComponent.ts:61

registeredControls

• Protected registeredControls: undefined | HardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>[]

Inherited from

HardwareUiControlList.registeredControls

Defined in

sdk/components/controls/HardwareUiControl.tsx:137

Accessors

isDisabled

• get isDisabled(): boolean

Gets whether or not the control is currently disabled.

Returns

boolean

True if disabled, false otherwise.

Inherited from

HardwareUiControlList.isDisabled

Defined in

sdk/components/controls/HardwareUiControl.tsx:177

isFocused

• get isFocused(): boolean

Gets whether or not the control is currently focused.

Returns

boolean

True if disabled, false otherwise.

Inherited from

HardwareUiControlList.isFocused

Defined in

sdk/components/controls/HardwareUiControl.tsx:185

isIsolated

• get isIsolated(): boolean

Gets whether or not the control is currently in scroll isolation.

Returns

boolean

True if currently in scroll isolation, false otherwise.

Inherited from

HardwareUiControlList.isIsolated

Defined in

sdk/components/controls/HardwareUiControl.tsx:193

length

• get length(): number

Gets the current number of registered child controls.

Returns

number

The current number of registered child controls.

Inherited from

HardwareUiControlList.length

Defined in

sdk/components/controls/HardwareUiControl.tsx:165

Methods

blur

▸ blur(): void

Blurs, or removes focus, from the component.

Returns

void

Inherited from

HardwareUiControlList.blur

Defined in

sdk/components/controls/HardwareUiControl.tsx:593

clearRegistered

▸ clearRegistered(): void

Clears the list of registered components.

Returns

void

Inherited from

HardwareUiControlList.clearRegistered

Defined in

sdk/components/controls/HardwareUiControl.tsx:793

consolidateKeyboardHEvent

▸ consolidateKeyboardHEvent(source, evt): boolean

Consolidates all key events and allows sub classes to override and implement specific keyboard input behaviors.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.
`evt`	`FmsHEvent`	FmsHEvent of the keyboard event.

Returns

boolean

always false for the top level version of the method.

Defined in

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

destroy

▸ destroy(): void

Returns

void

Inherit Doc

Inherited from

HardwareUiControlList.destroy

Defined in

sdk/components/controls/HardwareUiControl.tsx:923

ensureIndexInView

▸ ensureIndexInView(index, pinDirection?): void

Ensures an indexed list item is in view.

Parameters

Name	Type	Default value	Description
`index`	`number`	`undefined`	The index of the list item.
`pinDirection`	`"top"` \| `"none"` \| `"bottom"`	`'none'`	The end of the container which the element should be pinned to.

Returns

void

Inherited from

HardwareUiControlList.ensureIndexInView

Defined in

sdk/components/controls/HardwareUiControlList.tsx:385

focus

▸ focus(focusPosition): boolean

Brings focus to the control. Focusing the control will also blur the currently focused control, if any.

Parameters

Name	Type	Description
`focusPosition`	`FocusPosition`	The focus position to activate for descendents of this control.

Returns

boolean

Whether this control was successfully focused.

Inherited from

HardwareUiControlList.focus

Defined in

sdk/components/controls/HardwareUiControl.tsx:410

getChild

▸ getChild(index): undefined | HardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>

Gets a child control at the specified index.

Parameters

Name	Type	Description
`index`	`number`	The index of the child control to get.

Returns

undefined | HardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>

The specified child control.

Inherited from

HardwareUiControlList.getChild

Defined in

sdk/components/controls/HardwareUiControl.tsx:859

getChildInstance

▸ getChildInstance<TControl>(index): null | TControl

Gets the instance of the node at the specified index.

Type parameters

Name	Type
`TControl`	extends `HardwareUiControl`<`FmsUiControlEvents`, `HardwareUiControlProps`>

Parameters

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

Returns

null | TControl

The node instance of specified type.

Inherited from

HardwareUiControlList.getChildInstance

Defined in

sdk/components/controls/HardwareUiControlList.tsx:446

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

HardwareUiControlList.getContext

Defined in

sdk/components/FSComponent.ts:106

getData

▸ getData(index): null | T

Gets the data object related to the selected DOM element.

Parameters

Name	Type	Description
`index`	`number`	The index of the data to get.

Returns

null | T

The selected item, if found.

Inherited from

HardwareUiControlList.getData

Defined in

sdk/components/controls/HardwareUiControlList.tsx:407

getFocusPositionOnScroll

▸ getFocusPositionOnScroll(direction): FocusPosition

Gets the focus position to apply when this control is focused from a scroll.

Parameters

Name	Type	Description
`direction`	`ScrollDirection`	The direction of the scroll.

Returns

FocusPosition

The focus position to apply when this control is focused from a scroll.

Inherited from

HardwareUiControlList.getFocusPositionOnScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:250

getFocusedIndex

▸ getFocusedIndex(): number

Gets the current focused index in the registered controls collection.

Returns

number

The index of the focused control in the collection of registered controls.

Inherited from

HardwareUiControlList.getFocusedIndex

Defined in

sdk/components/controls/HardwareUiControl.tsx:824

getMostRecentFocusedIndex

▸ getMostRecentFocusedIndex(): number

Gets the most recent focused index (including the current focused index, if one exists) in the registered controls collection.

Returns

number

The index of the most recently focused control in the collection of registered controls.

Inherited from

HardwareUiControlList.getMostRecentFocusedIndex

Defined in

sdk/components/controls/HardwareUiControl.tsx:833

getSelectedElement

▸ getSelectedElement(): null | HTMLElement

Get the selected HTMLElement.

Returns

null | HTMLElement

The selected element, if found.

Inherited from

HardwareUiControlList.getSelectedElement

Defined in

sdk/components/controls/HardwareUiControlList.tsx:425

getSelectedIndex

▸ getSelectedIndex(): number

Gets the index of the currently selected element.

Returns

number

Selected element index. Returns -1 if nothing found.

Inherited from

HardwareUiControlList.getSelectedIndex

Defined in

sdk/components/controls/HardwareUiControlList.tsx:433

indexOf

▸ indexOf(child): number

Gets the index of a specified child control within the registered child controls collection.

Parameters

Name	Type	Description
`child`	`HardwareUiControl`<`FmsUiControlEvents`, `HardwareUiControlProps`>	The child to get the index of.

Returns

number

The index of the child, or -1 if not found.

Inherited from

HardwareUiControlList.indexOf

Defined in

sdk/components/controls/HardwareUiControl.tsx:873

on0

▸ on0(source): boolean

Handles the 0 key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on0

Defined in

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

on1

▸ on1(source): boolean

Handles the 1 key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on1

Defined in

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

on2

▸ on2(source): boolean

Handles the 2 key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on2

Defined in

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

on3

▸ on3(source): boolean

Handles the 3 key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on3

Defined in

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

on4

▸ on4(source): boolean

Handles the 4 key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on4

Defined in

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

on5

▸ on5(source): boolean

Handles the 5 key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on5

Defined in

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

on6

▸ on6(source): boolean

Handles the 6 key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on6

Defined in

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

on7

▸ on7(source): boolean

Handles the 7 key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on7

Defined in

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

on8

▸ on8(source): boolean

Handles the 8 key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on8

Defined in

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

on9

▸ on9(source): boolean

Handles the 9 key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on9

Defined in

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

onA

▸ onA(source): boolean

Handles the A key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onA

Defined in

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

onAfterRender

▸ onAfterRender(node): void

Parameters

Name	Type
`node`	`VNode`

Returns

void

Inherit Doc

Inherited from

HardwareUiControlList.onAfterRender

Defined in

sdk/components/controls/HardwareUiControlList.tsx:76

onAfterScroll

▸ onAfterScroll(control, index): void

An event called when a scroll operation has completed.

Parameters

Name	Type	Description
`control`	`HardwareUiControl`<`FmsUiControlEvents`, `HardwareUiControlProps`>	The control that was scrolled to.
`index`	`number`	The index of the control in the collection of registered controls.

Returns

void

Inherited from

HardwareUiControlList.onAfterScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:284

onB

▸ onB(source): boolean

Handles the B key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onB

Defined in

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

onBKSP

▸ onBKSP(source): boolean

Handles the BKSP key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onBKSP

Defined in

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

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

HardwareUiControlList.onBeforeRender

Defined in

sdk/components/FSComponent.ts:80

onBlurred

▸ onBlurred(source): void

Parameters

Name	Type
`source`	`HardwareUiControl`<`FmsUiControlEvents`, `GarminControlListProps`<`T`>>

Returns

void

Inherit Doc

Inherited from

HardwareUiControlList.onBlurred

Defined in

sdk/components/controls/HardwareUiControlList.tsx:456

onC

▸ onC(source): boolean

Handles the C key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onC

Defined in

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

onClr

▸ onClr(source): boolean

Handles CLR button press events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onClr

Defined in

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

onClrLong

▸ onClrLong(source): boolean

Handles CLR button long press events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onClrLong

Defined in

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

onCom

▸ onCom(source): boolean

Handles the COM key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onCom

Defined in

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

onCrs

▸ onCrs(source): boolean

Handles the CRS key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onCrs

Defined in

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

onD

▸ onD(source): boolean

Handles the D key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onD

Defined in

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

onDirectTo

▸ onDirectTo(source): boolean

Handles DRCT button press events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onDirectTo

Defined in

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

onDisabled

▸ onDisabled(source): void

An event called when the control is disabled.

Parameters

Name	Type	Description
`source`	`HardwareUiControl`<`FmsUiControlEvents`, `HardwareUiControlProps`>	The control that emitted this event.

Returns

void

Inherited from

HardwareUiControlList.onDisabled

Defined in

sdk/components/controls/HardwareUiControl.tsx:225

onDot

▸ onDot(source): boolean

Handles the Dot key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onDot

Defined in

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

onE

▸ onE(source): boolean

Handles the E key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onE

Defined in

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

onEnabled

▸ onEnabled(source): void

An event called when the control is enabled.

Parameters

Name	Type	Description
`source`	`HardwareUiControl`<`FmsUiControlEvents`, `HardwareUiControlProps`>	The control that emitted this event.

Returns

void

Inherited from

HardwareUiControlList.onEnabled

Defined in

sdk/components/controls/HardwareUiControl.tsx:217

onEnter

▸ onEnter(source): boolean

Handles ENTER button press events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onEnter

Defined in

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

onF

▸ onF(source): boolean

Handles the F key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onF

Defined in

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

onFPL

▸ onFPL(source): boolean

Handles FPL button press events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onFPL

Defined in

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

onFocused

▸ onFocused(source): void

An event called when the control receives focus.

Parameters

Name	Type	Description
`source`	`HardwareUiControl`<`FmsUiControlEvents`, `HardwareUiControlProps`>	The control that emitted this event.

Returns

void

Inherited from

HardwareUiControlList.onFocused

Defined in

sdk/components/controls/HardwareUiControl.tsx:201

onG

▸ onG(source): boolean

Handles the G key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onG

Defined in

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

onH

▸ onH(source): boolean

Handles the H key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onH

Defined in

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

onHome

▸ onHome(source): boolean

Handles the Home key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onHome

Defined in

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

onI

▸ onI(source): boolean

Handles the I key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onI

Defined in

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

onInnerControlKnobDec

▸ onInnerControlKnobDec(source): boolean

Handles Inner Control Knob decrease events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onInnerControlKnobDec

Defined in

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

onInnerControlKnobInc

▸ onInnerControlKnobInc(source): boolean

Handles Inner Control Knob increase events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onInnerControlKnobInc

Defined in

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

onInnerControlKnobPush

▸ onInnerControlKnobPush(source): boolean

Handles Inner Control Knob push events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onInnerControlKnobPush

Defined in

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

onInteractionEvent

▸ onInteractionEvent(evt): boolean

Parameters

Name	Type
`evt`	`FmsHEvent`

Returns

boolean

Inherit Doc

Overrides

HardwareUiControlList.onInteractionEvent

Defined in

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

onJ

▸ onJ(source): boolean

Handles the J key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onJ

Defined in

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

onJoystickDown

▸ onJoystickDown(source): boolean

Handles range joystick down deflection events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onJoystickDown

Defined in

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

onJoystickLeft

▸ onJoystickLeft(source): boolean

Handles range joystick left deflection events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onJoystickLeft

Defined in

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

onJoystickPush

▸ onJoystickPush(source): boolean

Handles range joystick push events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onJoystickPush

Defined in

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

onJoystickRight

▸ onJoystickRight(source): boolean

Handles range joystick right deflection events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onJoystickRight

Defined in

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

onJoystickUp

▸ onJoystickUp(source): boolean

Handles range joystick up deflection events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onJoystickUp

Defined in

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

onK

▸ onK(source): boolean

Handles the K key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onK

Defined in

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

onL

▸ onL(source): boolean

Handles the L key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onL

Defined in

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

onLowerKnobDec

▸ onLowerKnobDec(source): boolean

Handles FMS lower knob decrease events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onLowerKnobDec

Defined in

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

onLowerKnobInc

▸ onLowerKnobInc(source): boolean

Handles FMS lower knob increase events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onLowerKnobInc

Defined in

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

onM

▸ onM(source): boolean

Handles the M key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onM

Defined in

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

onMenu

▸ onMenu(source): boolean

Handles MENU button press events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onMenu

Defined in

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

onN

▸ onN(source): boolean

Handles the N key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onN

Defined in

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

onNav

▸ onNav(source): boolean

Handles the NAV key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onNav

Defined in

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

onO

▸ onO(source): boolean

Handles the O key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onO

Defined in

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

onOuterControlKnobDec

▸ onOuterControlKnobDec(source): boolean

Handles Outer Control Knob decrease events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onOuterControlKnobDec

Defined in

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

onOuterControlKnobInc

▸ onOuterControlKnobInc(source): boolean

Handles Outer Control Knob increase events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onOuterControlKnobInc

Defined in

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

onP

▸ onP(source): boolean

Handles the P key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onP

Defined in

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

onPlusMinus

▸ onPlusMinus(source): boolean

Handles the +/- key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onPlusMinus

Defined in

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

onProc

▸ onProc(source): boolean

Handles PROC button press events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onProc

Defined in

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

onQ

▸ onQ(source): boolean

Handles the Q key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onQ

Defined in

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

onR

▸ onR(source): boolean

Handles the R key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onR

Defined in

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

onRangeDec

▸ onRangeDec(source): boolean

Handles range joystick decrease events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onRangeDec

Defined in

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

onRangeInc

▸ onRangeInc(source): boolean

Handles range joystick increase events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onRangeInc

Defined in

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

onRegistered

▸ onRegistered(source): void

An event called when a control is registered with this control.

Parameters

Name	Type	Description
`source`	`HardwareUiControl`<`FmsUiControlEvents`, `HardwareUiControlProps`>	The control that emitted this event.

Returns

void

Inherited from

HardwareUiControlList.onRegistered

Defined in

sdk/components/controls/HardwareUiControl.tsx:233

onS

▸ onS(source): boolean

Handles the S key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onS

Defined in

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

onSPC

▸ onSPC(source): boolean

Handles the key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onSPC

Defined in

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

onScroll

▸ onScroll(direction): boolean

An event called when the control is scrolled.

Parameters

Name	Type	Description
`direction`	`ScrollDirection`	The direction that is being requested to scroll.

Returns

boolean

True if this control handled this event, false otherwise.

Inherited from

HardwareUiControlList.onScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:263

onT

▸ onT(source): boolean

Handles the T key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onT

Defined in

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

onU

▸ onU(source): boolean

Handles the U key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onU

Defined in

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

onUnregistered

▸ onUnregistered(source): void

An event called when a control is unregistered from this control.

Parameters

Name	Type	Description
`source`	`HardwareUiControl`<`FmsUiControlEvents`, `HardwareUiControlProps`>	The control that emitted this event.

Returns

void

Inherited from

HardwareUiControlList.onUnregistered

Defined in

sdk/components/controls/HardwareUiControl.tsx:241

onUpperKnobDec

▸ onUpperKnobDec(source): boolean

Handles FMS upper knob decrease events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onUpperKnobDec

Defined in

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

onUpperKnobInc

▸ onUpperKnobInc(source): boolean

Handles FMS upper knob increase events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onUpperKnobInc

Defined in

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

onUpperKnobPush

▸ onUpperKnobPush(source): boolean

Handles FMS upper knob push events.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onUpperKnobPush

Defined in

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

onV

▸ onV(source): boolean

Handles the V key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onV

Defined in

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

onW

▸ onW(source): boolean

Handles the W key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onW

Defined in

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

onX

▸ onX(source): boolean

Handles the X key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onX

Defined in

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

onXpdr

▸ onXpdr(source): boolean

Handles the XPDR key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onXpdr

Defined in

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

onY

▸ onY(source): boolean

Handles the Y key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onY

Defined in

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

onZ

▸ onZ(source): boolean

Handles the Z key.

Parameters

Name	Type	Description
`source`	`G1000UiControl`<`G1000UiControlProps`>	The source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onZ

Defined in

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

reconcileChildBlur

▸ reconcileChildBlur(index, child): number | BlurReconciliation

Reconciles the focus state of this control's children when this control is focused with no focused children after a child has been blurred.

Parameters

Name	Type	Description
`index`	`number`	The index of the child control that was blurred. If the child is no longer registered, then this is the index of the child prior to being unregistered.
`child`	`HardwareUiControl`<`FmsUiControlEvents`, `HardwareUiControlProps`>	The child control that was blurred.

Returns

number | BlurReconciliation

The index of the child control to focus.

Inherited from

HardwareUiControlList.reconcileChildBlur

Defined in

sdk/components/controls/HardwareUiControl.tsx:688

register

▸ register(control, index?): void

Registers a child control with this control.

Parameters

Name	Type	Description
`control`	`HardwareUiControl`<`FmsUiControlEvents`, `HardwareUiControlProps`>	The control to register.
`index?`	`number`	The index at which to register the control. If none is provided, the control will be registered at the end of the collection of child controls.

Returns

void

Inherited from

HardwareUiControlList.register

Defined in

sdk/components/controls/HardwareUiControl.tsx:722

render

▸ render(): VNode

Returns

VNode

Inherit Doc

Inherited from

HardwareUiControlList.render

Defined in

sdk/components/controls/HardwareUiControlList.tsx:499

renderScrollbar

▸ renderScrollbar(): VNode

Returns

VNode

Inherit Doc

Overrides

HardwareUiControlList.renderScrollbar

Defined in

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

scroll

▸ scroll(direction): boolean

Scrolls the currently focused control in the supplied direction.

Parameters

Name	Type	Description
`direction`	`ScrollDirection`	The direction that is being requested to scroll.

Returns

boolean

True if propagation should be stopped, false otherwise.

Inherited from

HardwareUiControlList.scroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:293

scrollToIndex

▸ scrollToIndex(index, focusPosition?): void

Scrolls to an item.

Parameters

Name	Type	Default value	Description
`index`	`number`	`undefined`	is the index of the list item to scroll to.
`focusPosition`	`FocusPosition`	`FocusPosition.First`	The focus position to apply to children of the item being scrolled to.

Returns

void

Inherited from

HardwareUiControlList.scrollToIndex

Defined in

sdk/components/controls/HardwareUiControlList.tsx:373

setDisabled

▸ setDisabled(isDisabled): void

Sets the component to be disabled, removing the ability for the component to scroll. Setting a component to disabled will also blur the component and its children, if necessary.

Parameters

Name	Type	Description
`isDisabled`	`boolean`	Whether or not the component is disabled.

Returns

void

Inherited from

HardwareUiControlList.setDisabled

Defined in

sdk/components/controls/HardwareUiControl.tsx:705

setFocusedIndex

▸ setFocusedIndex(index, focusPosition?): void

Sets the current most recently focused child control index. If this control is focused and has children that have focus, this will also switch child focus to the new index.

Parameters

Name	Type	Default value	Description
`index`	`number`	`undefined`	The index of the child control to set most recent focus for.
`focusPosition`	`FocusPosition`	`FocusPosition.MostRecent`	The focus position to focus the child for, if required.

Returns

void

Inherited from

HardwareUiControlList.setFocusedIndex

Defined in

sdk/components/controls/HardwareUiControl.tsx:843

setIsolated

▸ setIsolated(isolated): void

Sets whether or not this control is in scroll isolation. While scroll isolation is enabled, scroll events will not propagate to the control's parent when the control has focus.

Parameters

Name	Type	Description
`isolated`	`boolean`	Whether or not the control is isolated.

Returns

void

Inherited from

HardwareUiControlList.setIsolated

Defined in

sdk/components/controls/HardwareUiControl.tsx:895

setParent

▸ setParent(parent): void

Sets the parent of this control.

Parameters

Name	Type	Description
`parent`	`HardwareUiControl`<`FmsUiControlEvents`, `HardwareUiControlProps`>	The parent to set.

Returns

void

Inherited from

HardwareUiControlList.setParent

Defined in

sdk/components/controls/HardwareUiControl.tsx:885

triggerEvent

▸ triggerEvent(event, source, ...args): boolean

Triggers an event on this control. The event will first be routed to the deepest focused descendent of this control and will propagate up the control tree until it is handled or there are no more controls to which to propagate.

Parameters

Name	Type	Description
`event`	`FmsHEvent`	The event to trigger.
`source`	`HardwareUiControl`<`Record`<`string`, `any`>, `HardwareUiControlProps`>	The source of the event. Defaults to this if not supplied.
`...args`	`any`[]	Additional arguments to pass to the event handler.

Returns

boolean

True if the event was handled, false otherwise.

Inherited from

HardwareUiControlList.triggerEvent

Defined in

sdk/components/controls/HardwareUiControl.tsx:348

unregister

▸ unregister(item): void

Unregisters a child control with this control.

Parameters

Name	Type	Description
`item`	`number` \| `HardwareUiControl`<`FmsUiControlEvents`, `HardwareUiControlProps`>	The child control or index of a child control to unregister. If a child control is provided, it will attempt to be located in the control's child registry and then removed. If an index is provided, the child control at that registered index will be removed.

Returns

void

Inherited from

HardwareUiControlList.unregister

Defined in

sdk/components/controls/HardwareUiControl.tsx:748

updateOrder

▸ updateOrder(): void

Updates the order of data items in the list by the props supplied comparison function, if one exists.

Returns

void

Inherited from

HardwareUiControlList.updateOrder

Defined in

sdk/components/controls/HardwareUiControlList.tsx:276

Type parameters​

Hierarchy​

Implements​

Constructors​

constructor​

Type parameters​

Parameters​

Returns​

Inherited from​

Defined in​

Properties​

context​

Inherited from​

Defined in​

contextType​

Inherited from​

Defined in​

focusedIndex​

Inherited from​

Defined in​

props​

Inherited from​

Defined in​

registeredControls​

Inherited from​

Defined in​

Accessors​

isDisabled​

Returns​

Inherited from​

Defined in​

isFocused​

Returns​

Inherited from​

Defined in​

isIsolated​

Returns​

Inherited from​

Defined in​

length​

Returns​

Inherited from​

Defined in​

Methods​

blur​

Returns​

Inherited from​

Defined in​

clearRegistered​

Returns​

Inherited from​

Defined in​

consolidateKeyboardHEvent​

Parameters​

Returns​

Defined in​

destroy​

Returns​

Inherited from​

Defined in​

ensureIndexInView​

Parameters​

Returns​

Inherited from​

Defined in​

focus​

Parameters​

Returns​

Inherited from​

Defined in​

getChild​

Parameters​

Returns​

Inherited from​

Defined in​

getChildInstance​

Type parameters​

Parameters​

Returns​

Inherited from​

Type parameters

Hierarchy

Implements

Constructors

constructor

Type parameters

Parameters

Returns

Inherited from

Defined in

Properties

context

Inherited from

Defined in

contextType

Inherited from

Defined in

focusedIndex

Inherited from

Defined in

props

Inherited from

Defined in

registeredControls

Inherited from

Defined in

Accessors

isDisabled

Returns

Inherited from

Defined in

isFocused

Returns

Inherited from

Defined in

isIsolated

Returns

Inherited from

Defined in

length

Returns

Inherited from

Defined in

Methods

blur

Returns

Inherited from

Defined in

clearRegistered

Returns

Inherited from

Defined in

consolidateKeyboardHEvent

Parameters

Returns

Defined in

destroy

Returns

Inherited from

Defined in

ensureIndexInView

Parameters

Returns

Inherited from

Defined in

focus

Parameters

Returns

Inherited from

Defined in

getChild

Parameters

Returns

Inherited from

Defined in

getChildInstance

Type parameters

Parameters

Returns

Inherited from