Class: PFDProc
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/Procedure/PFDProc.tsx:20
The PFD procedures popout.
Extends
ListMenuDialog
<PFDProcProps
>
Constructors
Constructor
new PFDProc(
props
):PFDProc
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:36
Parameters
Parameter | Type |
---|---|
props | PFDProcProps |
Returns
PFDProc
Inherit Doc
Inherited from
Properties
context?
optional
context: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
focusSubject
protected
focusSubject:Subject
<boolean
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:33
Inherited from
inputData
inputData:
Subject
<any
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:36
Inherited from
listContainerRef
protected
listContainerRef:NodeReference
<HTMLElement
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Dialogs/ListMenuDialog.tsx:25
Inherited from
ListMenuDialog
.listContainerRef
listRef
protected
listRef:NodeReference
<List
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Dialogs/ListMenuDialog.tsx:24
Inherited from
menuItemsSubject
protected
menuItemsSubject:ArraySubject
<MenuItemDefinition
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Dialogs/ListMenuDialog.tsx:28
Inherited from
ListMenuDialog
.menuItemsSubject
onAccept
onAccept:
SubEventInterface
<PFDProc
,any
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:40
Inherited from
onClose
onClose:
SubEventInterface
<PFDProc
,void
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:39
Inherited from
onOpen
onOpen:
SubEventInterface
<PFDProc
,void
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:38
Inherited from
props
props:
PFDProcProps
&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
scrollController
protected
scrollController:ScrollController
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:32
Inherited from
ListMenuDialog
.scrollController
viewContainerRef
protected
readonly
viewContainerRef:NodeReference
<HTMLDivElement
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:32
Inherited from
ListMenuDialog
.viewContainerRef
viewResult
viewResult:
any
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:34
Inherited from
Methods
accept()
accept(
result?
,closeView?
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:108
Confirms the view result and closes the view.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
result? | any | 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
blur()
blur():
void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:71
Method to unfocus this control group
Returns
void
Inherited from
buildMenuItems()
protected
buildMenuItems():MenuItemDefinition
[]
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/Procedure/PFDProc.tsx:79
Gets the menu item definitions for the list.
Returns
menu item definitions.
Overrides
buildMenuList()
buildMenuList():
MenuItemDefinition
[]
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/Procedure/PFDProc.tsx:32
Method to dynamically build the menu list
Returns
an array of menu item definitions
close()
close(
quickclose
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:65
Closes the view.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
quickclose | boolean | false | bool stating whether to quickclose the child. |
Returns
void
Inherited from
destroy()
destroy():
void
Defined in: sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
Inherited from
focus()
focus(
dir
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:61
Method to focus this control group
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
dir | EntryDirection | 'top' | The direction of entry. |
Returns
void
Inherited from
getContext()
protected
getContext(context
):never
Defined in: sdk/components/FSComponent.ts:106
Gets a context data subscription from the context collection.
Parameters
Parameter | 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
getHighlightElement()
getHighlightElement():
null
|Element
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:125
This is just a dummy that exists here to be compatible with the union type of ScrollableControl
Returns
null
| Element
null
Inherited from
ListMenuDialog
.getHighlightElement
getIsFocusable()
getIsFocusable():
boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:88
Gets a boolean indicating if this control is able to be focused.
Returns
boolean
true
Inherited from
getIsFocused()
getIsFocused():
boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:80
Method to check if this UiControlGroup is in focus
Returns
boolean
true if the control group is in focus, false otherwise
Inherited from
notifyViewOpened()
protected
notifyViewOpened():void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:131
Notifies subscribers that the view has been opened.
Returns
void
Inherited from
ListMenuDialog
.notifyViewOpened
onAfterRender()
onAfterRender(
node
):void
Defined in: sdk/components/FSComponent.ts:87
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
onBeforeRender()
onBeforeRender():
void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:51
Returns
void
Inherit Doc
Inherited from
onBlurred()
protected
onBlurred():void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:244
A callback which is called when this control group is blurred.
Returns
void
Inherited from
onFocused()
protected
onFocused():void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:237
A callback which is called when this control group is focused.
Returns
void
Inherited from
onInputDataSet()
protected
onInputDataSet(input
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:194
Method to be overridden by view inheriting UiView to do something when the input data is set.
Parameters
Parameter | Type | Description |
---|---|---|
input | any | The data that was set. |
Returns
void
Inherited from
onInteractionEvent()
onInteractionEvent(
evt
):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Dialogs/ListMenuDialog.tsx:31
Handler for interaction events to be handled by the view.
Parameters
Parameter | Type | Description |
---|---|---|
evt | FmsHEvent | The HEvenet. |
Returns
boolean
true if the event was handled in this group
Inherited from
ListMenuDialog
.onInteractionEvent
onScrollToggled()
protected
onScrollToggled(enabled
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:97
A method called when the control group scroll is toggled.
Parameters
Parameter | Type | Description |
---|---|---|
enabled | boolean | if the scroll is enabled. |
Returns
void
Inherited from
ListMenuDialog
.onScrollToggled
onViewClosed()
protected
onViewClosed():void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:184
Method to be overridden by view inheriting UiView to do something when the dialog opens.
Returns
void
Inherited from
onViewOpened()
protected
onViewOpened():void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:169
Method to be overridden by view inheriting UiView to do something when the view opens.
Returns
void
Inherited from
onViewPaused()
protected
onViewPaused():void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:179
Method to be overridden by view inheriting UiView to do something when the dialog opens.
Returns
void
Inherited from
onViewResumed()
protected
onViewResumed():void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/Procedure/PFDProc.tsx:23
Method to be overridden by view inheriting UiView to do something when the dialog opens.
Returns
void
Overrides
open()
open(
isSubView
,zIndex?
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:47
Shows the view.
Parameters
Parameter | 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
pause()
pause():
void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:201
Pauses the view (usually only called by ViewService).
Returns
void
Inherited from
processHEvent()
processHEvent(
evt
):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:134
Handles HEvents and routes them to the subdialog when existant.
Parameters
Parameter | Type | Description |
---|---|---|
evt | FmsHEvent | The received event. |
Returns
boolean
true if the event was handled in this control group, false otherwise.
Inherited from
processScrollEvent()
protected
processScrollEvent(evt
):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:119
Attempts to handle scroll events.
Parameters
Parameter | Type | Description |
---|---|---|
evt | FmsHEvent | The received event. |
Returns
boolean
whether the event was handled.
Inherited from
ListMenuDialog
.processScrollEvent
register()
protected
register(ctrl
,unregister
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:226
Register/Unregisters a UiControl with the scroll controller.
Parameters
Parameter | 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
render()
render():
VNode
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Dialogs/ListMenuDialog.tsx:74
Renders the component.
Returns
VNode
The component VNode.
Inherited from
renderItem()
protected
renderItem(d
,registerFn
):VNode
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Dialogs/ListMenuDialog.tsx:54
A callback called to render the menu items.
Parameters
Parameter | Type | Description |
---|---|---|
d | MenuItemDefinition | is the menu item |
registerFn | (ctrl ) => void | The register function. |
Returns
VNode
a vnode for display in the menu
Inherited from
resume()
resume():
void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:208
Resumes the view (usually only called by ViewService).
Returns
void
Inherited from
routeEventToControl()
protected
routeEventToControl(evt
,control
):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:176
Routes an interaction event to a UiControl.
Parameters
Parameter | Type | Description |
---|---|---|
evt | FmsHEvent | An interaction event. |
control | UiControl | The UiControl to which to route the event. |
Returns
boolean
Whether the event was handled by the UiControl.
Inherited from
ListMenuDialog
.routeEventToControl
setInput()
setInput(
input
):this
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:97
Set data on this view.
Parameters
Parameter | Type | Description |
---|---|---|
input | any | The input data. |
Returns
this
This view instance for chain commands.
Inherited from
setMenuItems()
setMenuItems(
items
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Dialogs/ListMenuDialog.tsx:62
Sets the menu items for the list menu dialog.
Parameters
Parameter | Type | Description |
---|---|---|
items | MenuItemDefinition [] | The items to set into the menu. |
Returns
void
Inherited from
setScrollEnabled()
setScrollEnabled(
enabled
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:113
Sets the scroll enabled state
Parameters
Parameter | Type | Description |
---|---|---|
enabled | boolean | indicating if scrolling should be enabled |
Returns
void
Inherited from
ListMenuDialog
.setScrollEnabled
setZIndex()
setZIndex(
zIndex
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:88
Sets this view's z-index.
Parameters
Parameter | Type | Description |
---|---|---|
zIndex | undefined | number | The new z-indez. If not defined, the view's z-index will be reset. |
Returns
void
Inherited from
toggleScroll()
toggleScroll():
void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:104
Toggles the scroll highlighting
Returns
void