Class: ContextMenuDialog
A dialog that displays a context menu.
Hierarchyβ
UiView
<UiViewProps
,number
,ContextMenuOptions
>β³
ContextMenuDialog
Constructorsβ
constructorβ
β’ new ContextMenuDialog(props
): ContextMenuDialog
Constructor
Parametersβ
Name | Type | Description |
---|---|---|
props | UiViewProps | The view props. |
Returnsβ
Overridesβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Dialogs/ContextMenuDialog.tsx:100
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
focusSubjectβ
β’ Protected
focusSubject: Subject
<boolean
>
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:33
inputDataβ
β’ inputData: Subject
<undefined
| ContextMenuOptions
>
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:36
listRefβ
β’ Protected
Readonly
listRef: NodeReference
<G1000ControlList
<ContextMenuItemDefinition
>>
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Dialogs/ContextMenuDialog.tsx:76
onAcceptβ
β’ onAccept: SubEventInterface
<ContextMenuDialog
, undefined
| number
>
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:40
onCloseβ
β’ onClose: SubEventInterface
<ContextMenuDialog
, void
>
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:39
onOpenβ
β’ onOpen: SubEventInterface
<ContextMenuDialog
, void
>
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:38
propsβ
β’ props: UiViewProps
& ComponentProps
The properties of the component.
Inherited fromβ
Defined inβ
sdk/components/FSComponent.ts:61
scrollControllerβ
β’ Protected
scrollController: ScrollController
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:32
viewContainerRefβ
β’ Protected
Readonly
viewContainerRef: NodeReference
<HTMLDivElement
>
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:32
viewResultβ
β’ viewResult: undefined
| number
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:34
CHAR_WIDTHβ
βͺ Static
Readonly
CHAR_WIDTH: 12
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Dialogs/ContextMenuDialog.tsx:74
Methodsβ
acceptβ
βΈ accept(result?
, closeView?
): void
Confirms the view result and closes the view.
Parametersβ
Name | Type | Default value | Description |
---|---|---|---|
result? | number | undefined | Provide the view result if not already set. |
closeView | boolean | true | Indicates if the view should be closed after confirming the result. |
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:108
blurβ
βΈ blur(): void
Method to unfocus this control group
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:71
closeβ
βΈ close(quickclose?
): void
Closes the view.
Parametersβ
Name | Type | Default value | Description |
---|---|---|---|
quickclose | boolean | false | bool stating whether to quickclose the child. |
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:65
destroyβ
βΈ destroy(): void
Destroys this component.
Returnsβ
void
Inherited fromβ
Defined inβ
sdk/components/FSComponent.ts:98
focusβ
βΈ focus(dir?
): void
Method to focus this control group
Parametersβ
Name | Type | Default value | Description |
---|---|---|---|
dir | EntryDirection | 'top' | The direction of entry. |
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:61
getContextβ
βΈ getContext(context
): never
Gets a context data subscription from the context collection.
Parametersβ
Name | Type | Description |
---|---|---|
context | never | The context to get the subscription for. |
Returnsβ
never
The requested context.
Throws
An error if no data for the specified context type could be found.
Inherited fromβ
Defined inβ
sdk/components/FSComponent.ts:106
getHighlightElementβ
βΈ getHighlightElement(): null
| Element
This is just a dummy that exists here to be compatible with the union type of ScrollableControl
Returnsβ
null
| Element
null
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:125
getIsFocusableβ
βΈ getIsFocusable(): boolean
Gets a boolean indicating if this control is able to be focused.
Returnsβ
boolean
true
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:88
getIsFocusedβ
βΈ getIsFocused(): boolean
Method to check if this UiControlGroup is in focus
Returnsβ
boolean
true if the control group is in focus, false otherwise
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:80
notifyViewOpenedβ
βΈ notifyViewOpened(): void
Notifies subscribers that the view has been opened.
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:131
onAfterRenderβ
βΈ onAfterRender(node
): void
A callback that is called after the component is rendered.
Parametersβ
Name | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returnsβ
void
Inherited fromβ
Defined inβ
sdk/components/FSComponent.ts:87
onBeforeRenderβ
βΈ onBeforeRender(): void
Returnsβ
void
Inherit Doc
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:51
onBlurredβ
βΈ onBlurred(): void
A callback which is called when this control group is blurred.
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:244
onFocusedβ
βΈ onFocused(): void
A callback which is called when this control group is focused.
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:237
onInputDataSetβ
βΈ onInputDataSet(data
): void
Method to be overridden by view inheriting UiView to do something when the input data is set.
Parametersβ
Name | Type | Description |
---|---|---|
data | undefined | ContextMenuOptions | The data that was set. |
Returnsβ
void
Overridesβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Dialogs/ContextMenuDialog.tsx:114
onInteractionEventβ
βΈ onInteractionEvent(evt
): boolean
Handler for interaction events to be handled by the view.
Parametersβ
Name | Type | Description |
---|---|---|
evt | FmsHEvent | The HEvenet. |
Returnsβ
boolean
true if the event was handled in this group
Overridesβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Dialogs/ContextMenuDialog.tsx:169
onScrollToggledβ
βΈ onScrollToggled(enabled
): void
A method called when the control group scroll is toggled.
Parametersβ
Name | Type | Description |
---|---|---|
enabled | boolean | if the scroll is enabled. |
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:97
onViewClosedβ
βΈ onViewClosed(): void
Method to be overridden by view inheriting UiView to do something when the dialog opens.
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:184
onViewOpenedβ
βΈ onViewOpened(): void
Method to be overridden by view inheriting UiView to do something when the view opens.
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:169
onViewPausedβ
βΈ onViewPaused(): void
Method to be overridden by view inheriting UiView to do something when the dialog opens.
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:179
onViewResumedβ
βΈ onViewResumed(): void
Method to be overridden by view inheriting UiView to do something when the dialog opens.
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:174
openβ
βΈ open(isSubView
, zIndex?
): void
Shows the view.
Parametersβ
Name | Type | Description |
---|---|---|
isSubView | boolean | Whether the view is being displayed as a subview. |
zIndex? | number | The z-index to assign on the view container. |
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:47
pauseβ
βΈ pause(): void
Pauses the view (usually only called by ViewService).
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:201
processHEventβ
βΈ processHEvent(evt
): boolean
Handles HEvents and routes them to the subdialog when existant.
Parametersβ
Name | Type | Description |
---|---|---|
evt | FmsHEvent | The received event. |
Returnsβ
boolean
true if the event was handled in this control group, false otherwise.
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:134
processScrollEventβ
βΈ processScrollEvent(evt
): boolean
Attempts to handle scroll events.
Parametersβ
Name | Type | Description |
---|---|---|
evt | FmsHEvent | The received event. |
Returnsβ
boolean
whether the event was handled.
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:119
registerβ
βΈ register(ctrl
, unregister?
): void
Register/Unregisters a UiControl with the scroll controller.
Parametersβ
Name | Type | Default value | Description |
---|---|---|---|
ctrl | ScrollableControl | undefined | The UiControl to register. |
unregister | boolean | false | Indicates if the UiControl should be unregistered. |
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:226
renderβ
βΈ render(): VNode
Renders the component.
Returnsβ
VNode
A JSX element to be rendered.
Overridesβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Dialogs/ContextMenuDialog.tsx:225
resumeβ
βΈ resume(): void
Resumes the view (usually only called by ViewService).
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:208
routeEventToControlβ
βΈ routeEventToControl(evt
, control
): boolean
Routes an interaction event to a UiControl.
Parametersβ
Name | Type | Description |
---|---|---|
evt | FmsHEvent | An interaction event. |
control | UiControl <UiControlProps > | The UiControl to which to route the event. |
Returnsβ
boolean
Whether the event was handled by the UiControl.
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:176
setInputβ
βΈ setInput(input
): this
Set data on this view.
Parametersβ
Name | Type | Description |
---|---|---|
input | undefined | ContextMenuOptions | The input data. |
Returnsβ
this
This view instance for chain commands.
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:97
setScrollEnabledβ
βΈ setScrollEnabled(enabled
): void
Sets the scroll enabled state
Parametersβ
Name | Type | Description |
---|---|---|
enabled | boolean | indicating if scrolling should be enabled |
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:113
setZIndexβ
βΈ setZIndex(zIndex
): void
Sets this view's z-index.
Parametersβ
Name | Type | Description |
---|---|---|
zIndex | undefined | number | The new z-indez. If not defined, the view's z-index will be reset. |
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:88
toggleScrollβ
βΈ toggleScroll(): void
Toggles the scroll highlighting
Returnsβ
void
Inherited fromβ
Defined inβ
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:104