Class: MfdLwrOverlaysMenu
The MfdLwrOverlaysMenu component.
Hierarchy
GuiDialog<MfdLwrOverlaysMenuProps>↳
MfdLwrOverlaysMenu
Constructors
constructor
• new MfdLwrOverlaysMenu(props): MfdLwrOverlaysMenu
Ctor
Parameters
| Name | Type | Description |
|---|---|---|
props | MfdLwrOverlaysMenuProps | The component properties. |
Returns
Inherited from
GuiDialog<MfdLwrOverlaysMenuProps>.constructor
Defined in
workingtitle-instruments-wt21/shared/UI/GuiDialog.tsx:26
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
GuiDialog.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
GuiDialog.contextType
Defined in
sdk/components/FSComponent.ts:67
focusedIndex
• Protected focusedIndex: number = -1
Inherited from
GuiDialog.focusedIndex
Defined in
sdk/components/controls/HardwareUiControl.tsx:139
onClose
• Readonly onClose: SubEvent<MfdLwrOverlaysMenu, void>
Inherited from
GuiDialog.onClose
Defined in
workingtitle-instruments-wt21/shared/UI/GuiDialog.tsx:20
onOpen
• Readonly onOpen: SubEvent<MfdLwrOverlaysMenu, void>
Inherited from
GuiDialog.onOpen
Defined in
workingtitle-instruments-wt21/shared/UI/GuiDialog.tsx:19
props
• props: MfdLwrOverlaysMenuProps & ComponentProps
The properties of the component.
Inherited from
GuiDialog.props
Defined in
sdk/components/FSComponent.ts:61
registeredControls
• Protected registeredControls: undefined | HardwareUiControl<GuiUiControlEvents, HardwareUiControlProps>[]
Inherited from
GuiDialog.registeredControls
Defined in
sdk/components/controls/HardwareUiControl.tsx:137
FOCUS_CLASS
▪ Static Readonly FOCUS_CLASS: "highlight"
Inherited from
GuiDialog.FOCUS_CLASS
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:28
Accessors
isDisabled
• get isDisabled(): boolean
Gets whether or not the control is currently disabled.
Returns
boolean
True if disabled, false otherwise.
Inherited from
GuiDialog.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
GuiDialog.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
GuiDialog.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
GuiDialog.length
Defined in
sdk/components/controls/HardwareUiControl.tsx:165
Methods
blur
▸ blur(): void
Blurs, or removes focus, from the component.
Returns
void
Inherited from
GuiDialog.blur
Defined in
sdk/components/controls/HardwareUiControl.tsx:593
clearRegistered
▸ clearRegistered(): void
Clears the list of registered components.
Returns
void
Inherited from
GuiDialog.clearRegistered
Defined in
sdk/components/controls/HardwareUiControl.tsx:793
close
▸ close(): void
Hides the dialog.
Returns
void
Inherited from
GuiDialog.close
Defined in
workingtitle-instruments-wt21/shared/UI/GuiDialog.tsx:60
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Inherited from
GuiDialog.destroy
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
GuiDialog.focus
Defined in
sdk/components/controls/HardwareUiControl.tsx:410
getChild
▸ getChild(index): undefined | HardwareUiControl<GuiUiControlEvents, 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<GuiUiControlEvents, HardwareUiControlProps>
The specified child control.
Inherited from
GuiDialog.getChild
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
GuiDialog.getContext
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
GuiDialog.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
GuiDialog.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
GuiDialog.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<GuiUiControlEvents, HardwareUiControlProps> | The child to get the index of. |
Returns
number
The index of the child, or -1 if not found.
Inherited from
GuiDialog.indexOf
Defined in
sdk/components/controls/HardwareUiControl.tsx:873
onAfterRender
▸ onAfterRender(node): void
Parameters
| Name | Type |
|---|---|
node | VNode |
Returns
void
Inherit Doc
Overrides
GuiDialog.onAfterRender
Defined in
workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Menus/MfdLwrOverlaysMenu.tsx:19
onAfterScroll
▸ onAfterScroll(control, index): void
An event called when a scroll operation has completed.
Parameters
| Name | Type | Description |
|---|---|---|
control | HardwareUiControl<GuiUiControlEvents, HardwareUiControlProps> | The control that was scrolled to. |
index | number | The index of the control in the collection of registered controls. |
Returns
void
Inherited from
GuiDialog.onAfterScroll
Defined in
sdk/components/controls/HardwareUiControl.tsx:284
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
GuiDialog.onBeforeRender
Defined in
sdk/components/FSComponent.ts:80
onBlurred
▸ onBlurred(source): void
An event called when the control is blurred.
Parameters
| Name | Type | Description |
|---|---|---|
source | HardwareUiControl<GuiUiControlEvents, HardwareUiControlProps> | The control that emitted this event. |
Returns
void
Inherited from
GuiDialog.onBlurred
Defined in
sdk/components/controls/HardwareUiControl.tsx:209
onDisabled
▸ onDisabled(source): void
An event called when the control is disabled.
Parameters
| Name | Type | Description |
|---|---|---|
source | HardwareUiControl<GuiUiControlEvents, HardwareUiControlProps> | The control that emitted this event. |
Returns
void
Inherited from
GuiDialog.onDisabled
Defined in
sdk/components/controls/HardwareUiControl.tsx:225
onEnabled
▸ onEnabled(source): void
An event called when the control is enabled.
Parameters
| Name | Type | Description |
|---|---|---|
source | HardwareUiControl<GuiUiControlEvents, HardwareUiControlProps> | The control that emitted this event. |
Returns
void
Inherited from
GuiDialog.onEnabled
Defined in
sdk/components/controls/HardwareUiControl.tsx:217
onFocused
▸ onFocused(source): void
An event called when the control receives focus.
Parameters
| Name | Type | Description |
|---|---|---|
source | HardwareUiControl<GuiUiControlEvents, HardwareUiControlProps> | The control that emitted this event. |
Returns
void
Inherited from
GuiDialog.onFocused
Defined in
sdk/components/controls/HardwareUiControl.tsx:201
onInteractionEvent
▸ onInteractionEvent(evt): boolean
Parameters
| Name | Type |
|---|---|
evt | GuiHEvent |
Returns
boolean
Inherit Doc
Inherited from
GuiDialog.onInteractionEvent
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:40
onLowerKnobDec
▸ onLowerKnobDec(source): boolean
Handles GUI lower knob decrease events.
Parameters
| Name | Type | Description |
|---|---|---|
source | WT21UiControl<WT21UiControlProps> | The source of the event. |
Returns
boolean
Whether the event was handled.
Inherited from
GuiDialog.onLowerKnobDec
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:93
onLowerKnobInc
▸ onLowerKnobInc(source): boolean
Handles GUI lower knob increase events.
Parameters
| Name | Type | Description |
|---|---|---|
source | WT21UiControl<WT21UiControlProps> | The source of the event. |
Returns
boolean
Whether the event was handled.
Inherited from
GuiDialog.onLowerKnobInc
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:84
onLowerMenuPush
▸ onLowerMenuPush(source): boolean
Handles MFD LWR menu push events. (not implemented)
Parameters
| Name | Type | Description |
|---|---|---|
source | WT21UiControl<WT21UiControlProps> | The source of the event. |
Returns
boolean
Whether the event was handled.
Inherited from
GuiDialog.onLowerMenuPush
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:152
onMfdEsc
▸ onMfdEsc(source): boolean
Handles MFD esc events. (not implemented)
Parameters
| Name | Type | Description |
|---|---|---|
source | WT21UiControl<WT21UiControlProps> | The source of the event. |
Returns
boolean
Whether the event was handled.
Inherited from
GuiDialog.onMfdEsc
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:162
onPfdEsc
▸ onPfdEsc(source): boolean
Handles PFD esc events. (not implemented)
Parameters
| Name | Type | Description |
|---|---|---|
source | WT21UiControl<WT21UiControlProps> | The source of the event. |
Returns
boolean
Whether the event was handled.
Inherited from
GuiDialog.onPfdEsc
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:132
onPfdMenuPush
▸ onPfdMenuPush(source): boolean
Handles PFD menu push events. (not implemented)
Parameters
| Name | Type | Description |
|---|---|---|
source | WT21UiControl<WT21UiControlProps> | The source of the event. |
Returns
boolean
Whether the event was handled.
Inherited from
GuiDialog.onPfdMenuPush
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:112
onRefsMenuPush
▸ onRefsMenuPush(source): boolean
Handles REFS menu push events. (not implemented)
Parameters
| Name | Type | Description |
|---|---|---|
source | WT21UiControl<WT21UiControlProps> | The source of the event. |
Returns
boolean
Whether the event was handled.
Inherited from
GuiDialog.onRefsMenuPush
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:122
onRegistered
▸ onRegistered(source): void
An event called when a control is registered with this control.
Parameters
| Name | Type | Description |
|---|---|---|
source | HardwareUiControl<GuiUiControlEvents, HardwareUiControlProps> | The control that emitted this event. |
Returns
void
Inherited from
GuiDialog.onRegistered
Defined in
sdk/components/controls/HardwareUiControl.tsx:233
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
GuiDialog.onScroll
Defined in
sdk/components/controls/HardwareUiControl.tsx:263
onSoftkey1L
▸ onSoftkey1L(source): boolean
Parameters
| Name | Type |
|---|---|
source | WT21UiControl<WT21UiControlProps> |
Returns
boolean
Inherit Doc
Inherited from
GuiDialog.onSoftkey1L
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:169
onSoftkey1R
▸ onSoftkey1R(source): boolean
Parameters
| Name | Type |
|---|---|
source | WT21UiControl<WT21UiControlProps> |
Returns
boolean
Inherit Doc
Inherited from
GuiDialog.onSoftkey1R
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:193
onSoftkey2L
▸ onSoftkey2L(source): boolean
Parameters
| Name | Type |
|---|---|
source | WT21UiControl<WT21UiControlProps> |
Returns
boolean
Inherit Doc
Inherited from
GuiDialog.onSoftkey2L
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:175
onSoftkey2R
▸ onSoftkey2R(source): boolean
Parameters
| Name | Type |
|---|---|
source | WT21UiControl<WT21UiControlProps> |
Returns
boolean
Inherit Doc
Inherited from
GuiDialog.onSoftkey2R
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:199
onSoftkey3L
▸ onSoftkey3L(source): boolean
Parameters
| Name | Type |
|---|---|
source | WT21UiControl<WT21UiControlProps> |
Returns
boolean
Inherit Doc
Inherited from
GuiDialog.onSoftkey3L
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:181
onSoftkey3R
▸ onSoftkey3R(source): boolean
Parameters
| Name | Type |
|---|---|
source | WT21UiControl<WT21UiControlProps> |
Returns
boolean
Inherit Doc
Inherited from
GuiDialog.onSoftkey3R
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:205
onSoftkey4L
▸ onSoftkey4L(source): boolean
Parameters
| Name | Type |
|---|---|
source | WT21UiControl<WT21UiControlProps> |
Returns
boolean
Inherit Doc
Inherited from
GuiDialog.onSoftkey4L
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:187
onSoftkey4R
▸ onSoftkey4R(source): boolean
Parameters
| Name | Type |
|---|---|
source | WT21UiControl<WT21UiControlProps> |
Returns
boolean
Inherit Doc
Inherited from
GuiDialog.onSoftkey4R
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:211
onUnregistered
▸ onUnregistered(source): void
An event called when a control is unregistered from this control.
Parameters
| Name | Type | Description |
|---|---|---|
source | HardwareUiControl<GuiUiControlEvents, HardwareUiControlProps> | The control that emitted this event. |
Returns
void
Inherited from
GuiDialog.onUnregistered
Defined in
sdk/components/controls/HardwareUiControl.tsx:241
onUpperKnobDec
▸ onUpperKnobDec(source): boolean
Handles GUI upper knob decrease events.
Parameters
| Name | Type | Description |
|---|---|---|
source | WT21UiControl<WT21UiControlProps> | The source of the event. |
Returns
boolean
Whether the event was handled.
Inherited from
GuiDialog.onUpperKnobDec
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:75
onUpperKnobInc
▸ onUpperKnobInc(source): boolean
Handles GUI upper knob increase events.
Parameters
| Name | Type | Description |
|---|---|---|
source | WT21UiControl<WT21UiControlProps> | The source of the event. |
Returns
boolean
Whether the event was handled.
Inherited from
GuiDialog.onUpperKnobInc
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:66
onUpperKnobPush
▸ onUpperKnobPush(source): boolean
Handles upper knob push events.
Parameters
| Name | Type | Description |
|---|---|---|
source | WT21UiControl<WT21UiControlProps> | The source of the event. |
Returns
boolean
Whether the event was handled.
Inherited from
GuiDialog.onUpperKnobPush
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:102
onUpperMenuPush
▸ onUpperMenuPush(source): boolean
Handles MFD UPR menu push events. (not implemented)
Parameters
| Name | Type | Description |
|---|---|---|
source | WT21UiControl<WT21UiControlProps> | The source of the event. |
Returns
boolean
Whether the event was handled.
Inherited from
GuiDialog.onUpperMenuPush
Defined in
workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:142
open
▸ open(): void
Shows the dialog.
Returns
void
Inherited from
GuiDialog.open
Defined in
workingtitle-instruments-wt21/shared/UI/GuiDialog.tsx:52
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<GuiUiControlEvents, HardwareUiControlProps> | The child control that was blurred. |
Returns
number | BlurReconciliation
The index of the child control to focus.
Inherited from
GuiDialog.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<GuiUiControlEvents, 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
GuiDialog.register
Defined in
sdk/components/controls/HardwareUiControl.tsx:722
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Overrides
GuiDialog.render
Defined in
workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Menus/MfdLwrOverlaysMenu.tsx:49
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
GuiDialog.scroll
Defined in
sdk/components/controls/HardwareUiControl.tsx:293
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
GuiDialog.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
GuiDialog.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
GuiDialog.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<GuiUiControlEvents, HardwareUiControlProps> | The parent to set. |
Returns
void
Inherited from
GuiDialog.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 | GuiHEvent | 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
GuiDialog.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<GuiUiControlEvents, 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
GuiDialog.unregister
Defined in
sdk/components/controls/HardwareUiControl.tsx:748