Abstract Class: UiPage<T>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiPage.tsx:17

A UiPage component.

Extends

• UiView<T & UiViewProps>

Extended by

• MFDUiPage

Type Parameters

Type Parameter	Default type
T extends UiPageProps	UiPageProps

Constructors

Constructor

new UiPage<T>(props): UiPage<T>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiPage.tsx:28

Parameters

Parameter	Type
props	T

Returns

UiPage<T>

Inherit Doc

Overrides

UiView.constructor

Properties

_title

protected readonly _title: Subject<string>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiPage.tsx:18

---

context?

optional context: [] = undefined

Defined in: sdk/components/FSComponent.ts:64

The context on this component, if any.

Inherited from

UiView.context

---

contextType?

readonly optional contextType: readonly [] = undefined

Defined in: sdk/components/FSComponent.ts:67

The type of context for this component, if any.

Inherited from

UiView.contextType

---

focusSubject

protected focusSubject: Subject<boolean>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:33

Inherited from

UiView.focusSubject

---

inputData

inputData: Subject<any>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:36

Inherited from

UiView.inputData

---

isPaused

protected isPaused: boolean

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiPage.tsx:25

---

onAccept

onAccept: SubEventInterface<UiPage<T>, any>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:40

Inherited from

UiView.onAccept

---

onClose

onClose: SubEventInterface<UiPage<T>, void>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:39

Inherited from

UiView.onClose

---

onOpen

onOpen: SubEventInterface<UiPage<T>, void>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:38

Inherited from

UiView.onOpen

---

props

props: T & UiViewProps & ComponentProps

Defined in: sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from

UiView.props

---

scrollController

protected scrollController: ScrollController

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:32

Inherited from

UiView.scrollController

---

viewContainerRef

protected readonly viewContainerRef: NodeReference<HTMLDivElement>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:32

Inherited from

UiView.viewContainerRef

---

viewResult

viewResult: any

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:34

Inherited from

UiView.viewResult

Accessors

title

Get Signature

get title(): Subscribable<string>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiPage.tsx:21

The title of this page.

Returns

Subscribable<string>

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?	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

UiView.accept

---

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

UiView.blur

---

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

UiView.close

---

destroy()

destroy(): void

Defined in: sdk/components/FSComponent.ts:98

Destroys this component.

Returns

void

Inherited from

UiView.destroy

---

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

UiView.focus

---

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

UiView.getContext

---

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

UiView.getHighlightElement

---

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

UiView.getIsFocusable

---

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

UiView.getIsFocused

---

notifyViewOpened()

protected notifyViewOpened(): 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

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

UiView.onAfterRender

---

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

UiView.onBeforeRender

---

onBlurred()

protected onBlurred(): 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

UiView.onBlurred

---

onFocused()

protected onFocused(): 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

UiView.onFocused

---

onInputDataSet()

protected onInputDataSet(input): void

Defined in: workingtitle-instruments-g1000/html_ui/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

UiView.onInputDataSet

---

onInteractionEvent()

onInteractionEvent(evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:217

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

UiView.onInteractionEvent

---

onScrollToggled()

protected onScrollToggled(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

UiView.onScrollToggled

---

onViewClosed()

protected onViewClosed(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:184

Method to be overridden by view inheriting UiView to do something when the dialog opens.

Returns

void

Inherited from

UiView.onViewClosed

---

onViewOpened()

protected onViewOpened(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:169

Method to be overridden by view inheriting UiView to do something when the view opens.

Returns

void

Inherited from

UiView.onViewOpened

---

onViewPaused()

protected onViewPaused(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiPage.tsx:67

Method to be overridden by view inheriting UiView to do something when the dialog opens.

Returns

void

Overrides

UiView.onViewPaused

---

onViewResumed()

protected onViewResumed(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiPage.tsx:62

Method to be overridden by view inheriting UiView to do something when the dialog opens.

Returns

void

Overrides

UiView.onViewResumed

---

open()

open(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiPage.tsx:40

Opens the page.

Returns

void

Overrides

UiView.open

---

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

UiView.pause

---

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

UiView.processHEvent

---

processScrollEvent()

protected processScrollEvent(evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiPage.tsx:52

Attempts to handle scroll events.

Parameters

Parameter	Type	Description
evt	FmsHEvent	The received event.

Returns

boolean

whether the event was handled.

Overrides

UiView.processScrollEvent

---

register()

protected register(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

UiView.register

---

render()

abstract render(): null | VNode

Defined in: sdk/components/FSComponent.ts:93

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Inherited from

UiView.render

---

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

UiView.resume

---

routeEventToControl()

protected routeEventToControl(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

UiView.routeEventToControl

---

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	any	The input data.

Returns

this

This view instance for chain commands.

Inherited from

UiView.setInput

---

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

UiView.setScrollEnabled

---

setZIndex()

setZIndex(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiPage.tsx:47

This method has no effect.

Returns

void

Overrides

UiView.setZIndex

---

toggleScroll()

toggleScroll(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:104

Toggles the scroll highlighting

Returns

void

Inherited from

UiView.toggleScroll