The type parameter for the base view.
Constructs a new BaseAggregateView instance.
Private_Private_The transition for the view.
IHosannaView
OptionalaudioThis hint can be used in conjunction with the audio guide item
OptionalaudioIndicates whether the element can receive focus.
These are the children that are rendered on screen in the tree structure of the view
Indicdates whether the view is a focus group which means it can have a focused child Otherwise it will be focused itself
The current navigatable view.
OptionalcustomPrivatedefaultThe default transition effect used for aggregate view changes. Initialized with a FadeTransition instance.
PrivatedefaultThe key used to retrieve the default transition style for navigation controllers. This is typically used to determine the animation or visual effect applied during view transitions.
This key is used to look up the transition style in the style registry. If valid, created transition will be used instead of the default one (defaultTransition).
OptionalfocusedOptionalinitialIndicates whether auto-focus is enabled for the view.
Indicates whether the element is currently focused.
Indicates whether the view is managing visibility callbacks.
If true, this view has been presented in an AggregateViewController
OptionalonOptionalonOptionalparentThe parent focusable element, if any.
Indicates whether the view should be removed from the aggregate view.
These are the children that were created in getViews, in a flat strcuture - it contains EVERYTHING that we declared.
A temporary transition for the view.
Specifies the key used to determine the transition style for the view. This string can be used to select or identify different animation or transition effects when navigating between views or states within the application.
The IHosannaView subclass that created us in getViews
Indicates whether the navigatable entity is visible.
Transition state for the aggregate view.
Transition state for the aggregate view.
Children
OptionalmountTarget: IHosannaView<ViewState>View Creation
OptionalnextState: TPrivatebuildPrivatebuildBuilds the view and attaches it to the view owner.
OptionalmountTarget: IHosannaView<ViewState>The target to mount the view.
The built view or undefined.
Optionaloptions: IScreenDismissOptionsOptionalargs: Record<string, unknown>OptionalcancellationToken: HsCancellationTokenAsync Support
Optionalargs: Record<string, unknown>Optionalcallback: AsyncCommandEventCallbackResolves the next focusable element in the given direction.
The event containing details about the focus transition.
The next focusable element, or undefined if none exists.
Audio guide support
Measurement
Rendererers
Hibernates the view and its subviews by releasing native renderers and setting the view phase to Hibernating.
Hides the specified navigatable view.
The view to hide.
The view to be added as a subview.
index of the child in the parent view, -1 means add to end
Focus
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.
Called when the view gains focus.
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>.
Optionaloptions: IScreenPresentationOptionsOptional presentation options.
If true, the screen will be presented as a dialog.
If true, the screen transition will be animated.
Navigatable View
Transitions to the specified navigatable view.
The view to transition to.
Optionalanimated: boolean = trueWhether the transition should be animated.
Wakes up the view and its subviews by reserving native renderers and setting the view phase to Mounted.
The
BaseAggregateViewclass extendsBaseViewand implements theIAggregateViewinterface. It manages the visibility and transitions of navigatable views within an aggregate view.