Abstract Class: DirectTo
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:44
A view which provides control of the Direct-To function.
Extends
UiView<DirectToProps,undefined,DirectToInputData>
Extended by
Constructors
Constructor
new DirectTo(
props):DirectTo
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:36
Parameters
| Parameter | Type |
|---|---|
props | DirectToProps |
Returns
DirectTo
Inherit Doc
Inherited from
Properties
context?
optionalcontext: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
contextType?
readonlyoptionalcontextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
controller
protectedreadonlycontroller:DirectToController
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:52
courseOnesRef
protectedreadonlycourseOnesRef:NodeReference<NumberInput>
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:45
courseTensRef
protectedreadonlycourseTensRef:NodeReference<NumberInput>
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:46
focusSubject
protectedfocusSubject:Subject<boolean>
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:33
Inherited from
inputData
inputData:
Subject<undefined|DirectToInputData>
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:36
Inherited from
isOpen
protectedisOpen:boolean=false
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:56
onAccept
onAccept:
SubEventInterface<DirectTo,undefined>
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:40
Inherited from
onClose
onClose:
SubEventInterface<DirectTo,void>
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:39
Inherited from
onOpen
onOpen:
SubEventInterface<DirectTo,void>
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:38
Inherited from
planeHeading
protectedreadonlyplaneHeading:Subject<number>
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:49
planePos
protectedreadonlyplanePos:GeoPointSubject
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:48
props
props:
DirectToProps&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
scrollController
protectedscrollController:ScrollController
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:32
Inherited from
store
protectedreadonlystore:DirectToStore
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:51
unitSettingManager
protectedreadonlyunitSettingManager:UnitsUserSettingManager<UnitsUserSettingTypes>
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:54
viewContainerRef
protectedreadonlyviewContainerRef:NodeReference<HTMLDivElement>
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:32
Inherited from
viewResult
viewResult:
undefined
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:34
Inherited from
Methods
accept()
accept(
result?,closeView?):void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:108
Confirms the view result and closes the view.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
result? | undefined | 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/Shared/UI/UiControlGroup.tsx:71
Method to unfocus this control group
Returns
void
Inherited from
close()
close(
quickclose):void
Defined in: workingtitle-instruments-g1000/html_ui/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/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
getActivateScrollIndex()
protectedgetActivateScrollIndex():number
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:104
Method to get the activate scroll index for this instance.
Returns
number
The Activate Scroll Index.
getContext()
protectedgetContext(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/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
getIsFocusable()
getIsFocusable():
boolean
Defined in: workingtitle-instruments-g1000/html_ui/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/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
gotoActivateButton()
protectedgotoActivateButton():void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:96
Returns
void
Inherit Doc
notifyViewOpened()
protectednotifyViewOpened():void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:131
Notifies subscribers that the view has been opened.
Returns
void
Inherited from
onAfterRender()
onAfterRender(
node):void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:63
A callback that is called after the component is rendered.
Parameters
| Parameter | Type | Description |
|---|---|---|
node | VNode | The component's VNode. |
Returns
void
Overrides
onBeforeRender()
onBeforeRender():
void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:51
A callback that is called before the component is rendered.
Returns
void
Inherited from
onBlurred()
protectedonBlurred():void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:244
A callback which is called when this control group is blurred.
Returns
void
Inherited from
onFocused()
protectedonFocused():void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:237
A callback which is called when this control group is focused.
Returns
void
Inherited from
onHoldButtonPressed()
onHoldButtonPressed():
void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:111
Callback for when the Hold button is pressed.
Returns
void
onInputDataSet()
onInputDataSet(
directToInputData):void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:70
Method to be overridden by view inheriting UiView to do something when the input data is set.
Parameters
| Parameter | Type | Description |
|---|---|---|
directToInputData | undefined | DirectToInputData | The data that was set. |
Returns
void
Overrides
onInteractionEvent()
onInteractionEvent(
evt):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:85
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
Overrides
onLoadExecuted()
protectedonLoadExecuted():void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:233
A callback which is called when the Load action is executed.
Returns
void
onScrollToggled()
protectedonScrollToggled(enabled):void
Defined in: workingtitle-instruments-g1000/html_ui/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
onViewClosed()
protectedonViewClosed():void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:126
Method to be overridden by view inheriting UiView to do something when the dialog opens.
Returns
void
Overrides
onViewOpened()
protectedonViewOpened():void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:116
Method to be overridden by view inheriting UiView to do something when the view opens.
Returns
void
Overrides
onViewPaused()
protectedonViewPaused():void
Defined in: workingtitle-instruments-g1000/html_ui/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()
protectedonViewResumed():void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:174
Method to be overridden by view inheriting UiView to do something when the dialog opens.
Returns
void
Inherited from
open()
open(
isSubView,zIndex?):void
Defined in: workingtitle-instruments-g1000/html_ui/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/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/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()
protectedprocessScrollEvent(evt):boolean
Defined in: workingtitle-instruments-g1000/html_ui/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
register()
protectedregister(ctrl,unregister):void
Defined in: workingtitle-instruments-g1000/html_ui/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()
abstractrender():null|VNode
Defined in: sdk/components/FSComponent.ts:93
Renders the component.
Returns
null | VNode
A JSX element to be rendered.
Inherited from
renderBearing()
protectedrenderBearing(cssClass?):VNode
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:173
Renders a component which displays the bearing to the store's selected waypoint.
Parameters
| Parameter | Type | Description |
|---|---|---|
cssClass? | string | CSS class(es) to apply to the root of the component. |
Returns
a component which displays the bearing to the store's selected waypoint, as a VNode.
renderCourseInput()
protectedrenderCourseInput(cssClass?):VNode
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:203
Renders a component which allows the user to input the direct-to course.
Parameters
| Parameter | Type | Description |
|---|---|---|
cssClass? | string | CSS class(es) to apply to the root of the component. |
Returns
A component which allows the user to input the direct-to course, as a VNode.
renderDistance()
protectedrenderDistance(cssClass?):VNode
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:188
Renders a component which displays the distance to the store's selected waypoint.
Parameters
| Parameter | Type | Description |
|---|---|---|
cssClass? | string | CSS class(es) to apply to the root of the component. |
Returns
a component which displays the distance to the store's selected waypoint, as a VNode.
renderWaypointInput()
protectedrenderWaypointInput():VNode
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:153
Renders a waypoint input component.
Returns
a waypoint input component, as a VNode.
resume()
resume():
void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:208
Resumes the view (usually only called by ViewService).
Returns
void
Inherited from
routeEventToControl()
protectedrouteEventToControl(evt,control):boolean
Defined in: workingtitle-instruments-g1000/html_ui/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
setCourse()
protectedsetCourse():void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:79
Sets the course subject based on the number input fields.
Returns
void
setInput()
setInput(
input):this
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:97
Set data on this view.
Parameters
| Parameter | Type | Description |
|---|---|---|
input | undefined | DirectToInputData | The input data. |
Returns
this
This view instance for chain commands.
Inherited from
setScrollEnabled()
setScrollEnabled(
enabled):void
Defined in: workingtitle-instruments-g1000/html_ui/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
setZIndex()
setZIndex(
zIndex):void
Defined in: workingtitle-instruments-g1000/html_ui/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/Shared/UI/UiControlGroup.tsx:104
Toggles the scroll highlighting
Returns
void