Class: FPLDetails<P>
FPLDetails holds the core logic of the flight plan display and interacts with button events.
Type parameters
Name | Type |
---|---|
P | extends FPLDetailProps = FPLDetailProps |
Hierarchy
↳
FPLDetails
Constructors
constructor
• new FPLDetails<P
>(props
): FPLDetails
<P
>
Constructor
Type parameters
Name | Type |
---|---|
P | extends FPLDetailProps = FPLDetailProps |
Parameters
Name | Type | Description |
---|---|---|
props | P | the props |
Returns
FPLDetails
<P
>
Overrides
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:60
Properties
context
• Optional
context: [] = undefined
The context on this component, if any.
Inherited from
Defined in
sdk/components/FSComponent.ts:64
contextType
• Optional
Readonly
contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
Defined in
sdk/components/FSComponent.ts:67
controller
• Protected
Readonly
controller: FPLDetailsController
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:45
flightPlanElementSelectedHandler
• Protected
Readonly
flightPlanElementSelectedHandler: (selection
: FlightPlanSelection
) => void
Type declaration
▸ (selection
): void
Responds to flight plan element selections.
Parameters
Name | Type | Description |
---|---|---|
selection | FlightPlanSelection | The selection that was made. |
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:282
flightPlanFocusSelectedHandler
• Protected
Readonly
flightPlanFocusSelectedHandler: (focus
: FlightPlanFocus
) => void
Type declaration
▸ (focus
): void
Responds to flight plan focus selections.
Parameters
Name | Type | Description |
---|---|---|
focus | FlightPlanFocus | The focus selection that was made. |
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:283
focusedIndex
• Protected
focusedIndex: number
= -1
Inherited from
Defined in
sdk/components/controls/HardwareUiControl.tsx:139
fplDetailsContainer
• Protected
fplDetailsContainer: NodeReference
<HTMLElement
>
The departure through arrival phases, all of the FPLSections.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:52
fplnContainer
• fplnContainer: NodeReference
<HTMLElement
>
The complete flight plan container, including origin and destination info.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:49
isExtendedView
• Protected
isExtendedView: boolean
= false
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:46
props
• props: P
& ComponentProps
The properties of the component.
Inherited from
Defined in
sdk/components/FSComponent.ts:61
registeredControls
• Protected
registeredControls: undefined
| HardwareUiControl
<FmsUiControlEvents
, HardwareUiControlProps
>[]
Inherited from
G1000UiControl.registeredControls
Defined in
sdk/components/controls/HardwareUiControl.tsx:137
sectionListRef
• Protected
sectionListRef: NodeReference
<G1000ControlList
<FlightPlanSegment
>>
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:54
sectionRegisteredHandler
• Protected
Readonly
sectionRegisteredHandler: (source
: HardwareUiControl
<Record
<string
, any
>, HardwareUiControlProps
>) => void
Type declaration
▸ (source
): void
Parameters
Name | Type |
---|---|
source | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:281
store
• Protected
Readonly
store: FPLDetailsStore
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:44
Accessors
isDisabled
• get
isDisabled(): boolean
Gets whether or not the control is currently disabled.
Returns
boolean
True if disabled, false otherwise.
Inherited from
G1000UiControl.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
G1000UiControl.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
G1000UiControl.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
G1000UiControl.length
Defined in
sdk/components/controls/HardwareUiControl.tsx:165
Methods
blur
▸ blur(): void
Blurs, or removes focus, from the component.
Returns
void
Inherited from
Defined in
sdk/components/controls/HardwareUiControl.tsx:593
clearRegistered
▸ clearRegistered(): void
Clears the list of registered components.
Returns
void
Inherited from
G1000UiControl.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.
Inherited from
G1000UiControl.consolidateKeyboardHEvent
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:677
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Inherited from
Defined in
sdk/components/controls/HardwareUiControl.tsx:923
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
Defined in
sdk/components/controls/HardwareUiControl.tsx:410
fplViewOpened
▸ fplViewOpened(focusActiveLeg
): void
Called when the FPL view is opened.
Parameters
Name | Type | Description |
---|---|---|
focusActiveLeg | boolean | Whether or not to focus the active leg. |
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:82
fplViewResumed
▸ fplViewResumed(): void
Called when the fpl view is resumed.
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:73
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
Defined in
sdk/components/controls/HardwareUiControl.tsx:859
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
Defined in
sdk/components/FSComponent.ts:106
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
G1000UiControl.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
G1000UiControl.getFocusedIndex
Defined in
sdk/components/controls/HardwareUiControl.tsx:824
getListElementTopLocation
▸ getListElementTopLocation(segmentIndex
, legIndex
): number
Gets the top location of the list element for the specified segment and leg.
Parameters
Name | Type | Description |
---|---|---|
segmentIndex | number | The segment index. |
legIndex | number | The leg index. |
Returns
number
list element y coordinate
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:236
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
G1000UiControl.getMostRecentFocusedIndex
Defined in
sdk/components/controls/HardwareUiControl.tsx:833
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
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:514
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:523
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:532
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:541
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:550
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:559
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:568
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:577
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:586
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:595
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:271
onAfterRender
▸ onAfterRender(node
): void
Parameters
Name | Type |
---|---|
node | VNode |
Returns
void
Inherit Doc
Overrides
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:67
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
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:280
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:613
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
Defined in
sdk/components/FSComponent.ts:80
onBlurred
▸ onBlurred(): void
An event called when the control is blurred.
Returns
void
Overrides
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:92
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:289
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:163
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:172
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:640
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:667
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:298
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:181
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
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:604
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:307
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
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:154
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:316
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:190
onFlightPlanElementSelected
▸ onFlightPlanElementSelected(selection
): void
Responds to flight plan element selections.
Parameters
Name | Type | Description |
---|---|---|
selection | FlightPlanSelection | The selection that was made. |
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:268
onFlightPlanFocusSelected
▸ onFlightPlanFocusSelected(focus
): void
Responds to flight plan focus selections.
Parameters
Name | Type | Description |
---|---|---|
focus | FlightPlanFocus | The focus selection that was made. |
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:277
onFocused
▸ onFocused(): void
An event called when the control receives focus.
Returns
void
Overrides
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:87
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:325
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:334
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:631
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:343
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.
Inherited from
G1000UiControl.onInnerControlKnobDec
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:100
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.
Inherited from
G1000UiControl.onInnerControlKnobInc
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:109
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.
Inherited from
G1000UiControl.onInnerControlKnobPush
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:118
onInteractionEvent
▸ onInteractionEvent(evt
): boolean
Parameters
Name | Type |
---|---|
evt | FmsHEvent |
Returns
boolean
Inherit Doc
Inherited from
G1000UiControl.onInteractionEvent
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:29
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:352
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:262
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:235
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:226
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.
Inherited from
G1000UiControl.onJoystickRight
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:253
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:244
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:361
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:370
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:82
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:73
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:379
onMenu
▸ onMenu(): boolean
Handles MENU button press events.
Returns
boolean
Whether the event was handled.
Overrides
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:111
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:388
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:649
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:397
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.
Inherited from
G1000UiControl.onOuterControlKnobDec
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:127
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.
Inherited from
G1000UiControl.onOuterControlKnobInc
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:136
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:406
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:622
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:199
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:415
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:424
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:217
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:208
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
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:433
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:505
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
Defined in
sdk/components/controls/HardwareUiControl.tsx:263
onSectionRegistered
▸ onSectionRegistered(section
): void
Responds to flight plan section registered events.
Parameters
Name | Type | Description |
---|---|---|
section | FPLSection | The section that was registered. |
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:257
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:442
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:451
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
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:64
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:55
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.
Inherited from
G1000UiControl.onUpperKnobPush
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:91
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:460
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:469
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:478
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:658
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:487
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.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:496
openDetailsMenu
▸ openDetailsMenu(): boolean
Responds to menu button press events.
Returns
boolean
Whether the event was handled.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:119
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
G1000UiControl.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
Defined in
sdk/components/controls/HardwareUiControl.tsx:722
render
▸ render(): VNode
Render the component.
Returns
VNode
The component VNode.
Overrides
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:370
renderItem
▸ renderItem(data
, index
): VNode
Renders a section in the flight plan.
Parameters
Name | Type | Description |
---|---|---|
data | FlightPlanSegment | The data object for this section. |
index | number | The index. |
Returns
VNode
The rendered VNode.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:291
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
Defined in
sdk/components/controls/HardwareUiControl.tsx:293
scrollToActiveLeg
▸ scrollToActiveLeg(focusActiveLeg
): void
Scrolls to the active leg in the flight plan.
Parameters
Name | Type | Description |
---|---|---|
focusActiveLeg | boolean | Whether to focus the active leg. |
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/FPL/FPLDetails.tsx:100
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
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
G1000UiControl.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
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
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
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
Defined in
sdk/components/controls/HardwareUiControl.tsx:748