IHosannaView
Optional
audioThis hint can be used in conjunction with the audio guide item
Optional
audioIndicates whether the element can receive focus.
These are the children that are rendered on screen in the tree structure of the view
Indicates this is a composite view.
Optional
customOptional
focusedIndicates whether the element is currently focused.
If true, this view has been presented in an AggregateViewController
Optional
parentThese are the children that were created in getViews, in a flat strcuture - it contains EVERYTHING that we declared.
The IHosannaView subclass that created us in getViews
Indicates whether the navigatable entity is visible.
Children
Optional
mountTarget: IHosannaView<ViewState>View Creation
Optional
nextState: GroupStateBuilds the view and attaches it to the view owner.
Optional
mountTarget: IHosannaView<ViewState>The target to mount the view.
The built view or undefined.
Private
calculateCalculates the Euclidean distance between the centers of two rectangles.
The first rectangle.
The second rectangle.
The distance between centers.
Optional
options: IScreenDismissOptionsOptional
args: Record<string, unknown>Optional
cancellationToken: HsCancellationTokenAsync Support
Optional
args: Record<string, unknown>Optional
callback: AsyncCommandEventCallbackFinds the next focusable child in the specified direction.
The focus resolution event.
The next focusable view or undefined.
Private
findFinds the next focusable index in the specified direction and axis.
The current index.
The offset to move.
The axis ('x' or 'y').
The next focusable index.
Audio guide support
Measurement
Finds the closest child view in the direction of focus movement.
The focus resolution event.
The closest focusable child or undefined.
Rendererers
Private
getGets the bounding rectangle of a view from its renderer.
The view to get bounds for.
The bounding rectangle.
Hibernates the view and its subviews by releasing native renderers and setting the view phase to Hibernating.
The view to be added as a subview.
index of the child in the parent view, -1 means add to end
Private
isDetermines if the target bounds are in the specified direction from the source bounds.
True if in direction, false otherwise.
Focus
Lays out the child views within the group.
Measures the group and its children, updating layout properties.
Called when the navigatable entity is shown.
DO NOT CALL THIS METHOD DIRECTLY DO NOT OVERRIDE IT
Called after the navigatable entity has been added to an aggregate view.
The aggregate view to which the entity has been added.
Called after the navigatable entity has been removed from an aggregate view.
The aggregate view from which the entity has been removed.
Called when the navigatable entity is hidden.
DO NOT CALL THIS METHOD DIRECTLY DO NOT OVERRIDE IT
Handles a key event.
The key event to handle.
True if the key event was handled, false otherwise.
Called before the navigatable entity is added to an aggregate view.
The aggregate view to which the entity will be added.
This method is called before applying state changes to the view. It is used to perform any necessary preparations before the state changes are applied.
Called before the navigatable entity is removed from an aggregate view.
The aggregate view from which the entity will be removed.
Presents a new screen in the navigation stack or as a dialog.
The screen to be presented, represented by a ViewStruct<ViewState>
.
Optional
options: IScreenPresentationOptionsOptional presentation options.
If true, the screen will be presented as a dialog.
If true, the screen transition will be animated.
IReusable implementation
Renders the group view with the given state changes.
Partial state changes to apply.
Navigatable View
Wakes up the view and its subviews by reserving native renderers and setting the view phase to Mounted.
GroupView is a composite view for grouping child views together.
Remarks