Class: UiView<T, RV, IV>

A UiView component.

Type parameters

Name	Type
T	extends UiViewProps = UiViewProps
RV	any
IV	any

Hierarchy

• UiControlGroup<T>

  ↳ UiView

  ↳↳ SelectAirway

  ↳↳ ContextMenuDialog

  ↳↳ ListMenuDialog

  ↳↳ MessageDialog

  ↳↳ DirectTo

  ↳↳ Hold

  ↳↳ SetRunway

  ↳↳ WptDupDialog

  ↳↳ WptInfo

  ↳↳ UiPage

  ↳↳ MFDMapSettings

  ↳↳ MFDProc

  ↳↳ MFDPageSelect

  ↳↳ ADFDME

  ↳↳ Alerts

  ↳↳ FPL

  ↳↳ PFDSelectApproachView

  ↳↳ PFDSelectArrivalView

  ↳↳ PFDSelectDepartureView

  ↳↳ TimerRef

  ↳↳ Nearest

  ↳↳ PFDSetup

Constructors

constructor

• new UiView<T, RV, IV>(props): UiView<T, RV, IV>

Type parameters

Name	Type
T	extends UiViewProps = UiViewProps
RV	any
IV	any

Parameters

Name	Type
props	T

Returns

UiView<T, RV, IV>

Inherit Doc

Inherited from

UiControlGroup.constructor

Defined in

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

Properties

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

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

UiControlGroup.contextType

Defined in

sdk/components/FSComponent.ts:67

---

focusSubject

• Protected focusSubject: Subject<boolean>

Inherited from

UiControlGroup.focusSubject

Defined in

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

---

inputData

• inputData: Subject<undefined | IV>

Defined in

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

---

onAccept

• onAccept: SubEventInterface<UiView<T, RV, IV>, undefined | RV>

Defined in

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

---

onClose

• onClose: SubEventInterface<UiView<T, RV, IV>, void>

Defined in

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

---

onOpen

• onOpen: SubEventInterface<UiView<T, RV, IV>, void>

Defined in

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

---

props

• props: T & ComponentProps

The properties of the component.

Inherited from

UiControlGroup.props

Defined in

sdk/components/FSComponent.ts:61

---

scrollController

• Protected scrollController: ScrollController

Inherited from

UiControlGroup.scrollController

Defined in

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

---

viewContainerRef

• Protected Readonly viewContainerRef: NodeReference<HTMLDivElement>

Defined in

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

---

viewResult

• viewResult: undefined | RV

Defined in

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

Methods

accept

▸ accept(result?, closeView?): void

Confirms the view result and closes the view.

Parameters

Name	Type	Default value	Description
result?	RV	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

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

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

Name	Type	Default value	Description
quickclose	boolean	false	bool stating whether to quickclose the child.

Returns

void

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

UiControlGroup.destroy

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

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

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

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

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

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

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

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

UiControlGroup.onAfterRender

Defined in

sdk/components/FSComponent.ts:87

---

onBeforeRender

▸ onBeforeRender(): void

Returns

void

Inherit Doc

Inherited from

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

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

UiControlGroup.onFocused

Defined in

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

---

onInputDataSet

▸ onInputDataSet(input): void

Method to be overridden by view inheriting UiView to do something when the input data is set.

Parameters

Name	Type	Description
input	undefined | IV	The data that was set.

Returns

void

Defined in

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

---

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

Inherited from

UiControlGroup.onInteractionEvent

Defined in

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

---

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

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

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

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

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

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

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

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

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

Name	Type	Description
evt	FmsHEvent	The received event.

Returns

boolean

whether the event was handled.

Overrides

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

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

UiControlGroup.register

Defined in

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

---

render

▸ render(): null | VNode

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Inherited from

UiControlGroup.render

Defined in

sdk/components/FSComponent.ts:93

---

resume

▸ resume(): void

Resumes the view (usually only called by ViewService).

Returns

void

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

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

Name	Type	Description
input	undefined | IV	The input data.

Returns

this

This view instance for chain commands.

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

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

Name	Type	Description
zIndex	undefined | number	The new z-indez. If not defined, the view's z-index will be reset.

Returns

void

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

UiControlGroup.toggleScroll

Defined in

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