Skip to main content

Class: ContextMenuDialog

A dialog that displays a context menu.

Hierarchy​

Constructors​

constructor​

β€’ new ContextMenuDialog(props): ContextMenuDialog

Constructor

Parameters​

NameTypeDescription
propsUiViewPropsThe view props.

Returns​

ContextMenuDialog

Overrides​

UiView.constructor

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​

UiView.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​

UiView.contextType

Defined in​

sdk/components/FSComponent.ts:67


focusSubject​

β€’ Protected focusSubject: Subject<boolean>

Inherited from​

UiView.focusSubject

Defined in​

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


inputData​

β€’ inputData: Subject<undefined | ContextMenuOptions>

Inherited from​

UiView.inputData

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​

UiView.onAccept

Defined in​

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


onClose​

β€’ onClose: SubEventInterface<ContextMenuDialog, void>

Inherited from​

UiView.onClose

Defined in​

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


onOpen​

β€’ onOpen: SubEventInterface<ContextMenuDialog, void>

Inherited from​

UiView.onOpen

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​

UiView.props

Defined in​

sdk/components/FSComponent.ts:61


scrollController​

β€’ Protected scrollController: ScrollController

Inherited from​

UiView.scrollController

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​

UiView.viewContainerRef

Defined in​

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


viewResult​

β€’ viewResult: undefined | number

Inherited from​

UiView.viewResult

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​

NameTypeDefault valueDescription
result?numberundefinedProvide the view result if not already set.
closeViewbooleantrueIndicates if the view should be closed after confirming the result.

Returns​

void

Inherited from​

UiView.accept

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​

UiView.blur

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​

NameTypeDefault valueDescription
quickclosebooleanfalsebool stating whether to quickclose the child.

Returns​

void

Inherited from​

UiView.close

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​

UiView.destroy

Defined in​

sdk/components/FSComponent.ts:98


focus​

β–Έ focus(dir?): void

Method to focus this control group

Parameters​

NameTypeDefault valueDescription
dirEntryDirection'top'The direction of entry.

Returns​

void

Inherited from​

UiView.focus

Defined in​

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


getContext​

β–Έ getContext(context): never

Gets a context data subscription from the context collection.

Parameters​

NameTypeDescription
contextneverThe 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​

UiView.getContext

Defined in​

sdk/components/FSComponent.ts:106


getHighlightElement​

β–Έ getHighlightElement(): null | Element

This is just a dummy that exists here to be compatible with the union type of ScrollableControl

Returns​

null | Element

null

Inherited from​

UiView.getHighlightElement

Defined in​

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


getIsFocusable​

β–Έ getIsFocusable(): boolean

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

Returns​

boolean

true

Inherited from​

UiView.getIsFocusable

Defined in​

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


getIsFocused​

β–Έ getIsFocused(): boolean

Method to check if this UiControlGroup is in focus

Returns​

boolean

true if the control group is in focus, false otherwise

Inherited from​

UiView.getIsFocused

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​

UiView.notifyViewOpened

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​

NameTypeDescription
nodeVNodeThe component's VNode.

Returns​

void

Inherited from​

UiView.onAfterRender

Defined in​

sdk/components/FSComponent.ts:87


onBeforeRender​

β–Έ onBeforeRender(): void

Returns​

void

Inherit Doc

Inherited from​

UiView.onBeforeRender

Defined in​

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


onBlurred​

β–Έ onBlurred(): void

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

Returns​

void

Inherited from​

UiView.onBlurred

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​

UiView.onFocused

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​

NameTypeDescription
dataundefined | ContextMenuOptionsThe data that was set.

Returns​

void

Overrides​

UiView.onInputDataSet

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​

NameTypeDescription
evtFmsHEventThe HEvenet.

Returns​

boolean

true if the event was handled in this group

Overrides​

UiView.onInteractionEvent

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​

NameTypeDescription
enabledbooleanif the scroll is enabled.

Returns​

void

Inherited from​

UiView.onScrollToggled

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​

UiView.onViewClosed

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​

UiView.onViewOpened

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​

UiView.onViewPaused

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​

UiView.onViewResumed

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​

NameTypeDescription
isSubViewbooleanWhether the view is being displayed as a subview.
zIndex?numberThe z-index to assign on the view container.

Returns​

void

Inherited from​

UiView.open

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​

UiView.pause

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​

NameTypeDescription
evtFmsHEventThe received event.

Returns​

boolean

true if the event was handled in this control group, false otherwise.

Inherited from​

UiView.processHEvent

Defined in​

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


processScrollEvent​

β–Έ processScrollEvent(evt): boolean

Attempts to handle scroll events.

Parameters​

NameTypeDescription
evtFmsHEventThe received event.

Returns​

boolean

whether the event was handled.

Inherited from​

UiView.processScrollEvent

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​

NameTypeDefault valueDescription
ctrlScrollableControlundefinedThe UiControl to register.
unregisterbooleanfalseIndicates if the UiControl should be unregistered.

Returns​

void

Inherited from​

UiView.register

Defined in​

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


render​

β–Έ render(): VNode

Renders the component.

Returns​

VNode

A JSX element to be rendered.

Overrides​

UiView.render

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​

UiView.resume

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​

NameTypeDescription
evtFmsHEventAn interaction event.
controlUiControl<UiControlProps>The UiControl to which to route the event.

Returns​

boolean

Whether the event was handled by the UiControl.

Inherited from​

UiView.routeEventToControl

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​

NameTypeDescription
inputundefined | ContextMenuOptionsThe input data.

Returns​

this

This view instance for chain commands.

Inherited from​

UiView.setInput

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​

NameTypeDescription
enabledbooleanindicating if scrolling should be enabled

Returns​

void

Inherited from​

UiView.setScrollEnabled

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​

NameTypeDescription
zIndexundefined | numberThe new z-indez. If not defined, the view's z-index will be reset.

Returns​

void

Inherited from​

UiView.setZIndex

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​

UiView.toggleScroll

Defined in​

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