hosanna-ui-docs - v0.9.0
    Preparing search index...

    Interface IAggregateView

    Interface representing an aggregate view.

    interface IAggregateView {
        _cacheKey?: string;
        _hid?: string;
        allowViewHibernation?: boolean;
        calculatedHeight: number;
        calculatedWidth: number;
        calculatedX: number;
        calculatedY: number;
        canReceiveFocus: boolean;
        children: IHosannaView<ViewState>[];
        contentId?: string;
        currentView?: IHosannaView<ViewState>;
        id: string;
        includeInLayout: boolean;
        isAutoFocusEnabled: boolean;
        isFocused: boolean;
        isManagingVisibilityCallbacks: boolean;
        isPresented: boolean;
        onViewAdded?: onViewAddedHandler;
        onViewRemoved?: onViewRemovedHandler;
        parent?: IHosannaView<ViewState>;
        shouldRemoveFromAggregateView: boolean;
        subViews: IHosannaView<ViewState>[];
        tempTransition: undefined | AggregateViewTransition.AggregateViewTransition;
        transitionStyleKey?: string;
        viewOwner?: IHosannaView<ViewState>;
        visible: boolean;
        get renderer(): undefined | ISGNGroup;
        set renderer(renderer: undefined | ISGNGroup): void;
        get transition(): | undefined
        | AggregateViewTransition.AggregateViewTransition;
        get viewPhase(): ViewPhase;
        set viewPhase(viewPhase: ViewPhase): void;
        addChild(
            view: IHosannaView<ViewState>,
            mountTarget: undefined | IHosannaView<ViewState>,
        ): unknown;
        addSubView(view: IHosannaView<ViewState>): void;
        containsChild(child: IHosannaView<ViewState>): boolean;
        dismiss(options?: IScreenDismissOptions): void;
        dispatchAction<T>(options: IActionOptions<T>): void;
        dispatchAsync(
            command: string,
            args?: Record<string, unknown>,
            callback?: AsyncCommandEventCallback,
        ): AsyncCommand;
        dispatchSelection(options: ISelectionOptions): void;
        findNextFocusable(
            event: INextFocusResolutionEvent,
        ): undefined | IFocusable | NextViewFocus;
        getAudioGuideItem(): undefined | IAudioGuideItem;
        getBounds(): I2DRectangle;
        getBoundsInApp(): I2DRectangle;
        getBoundsInParent(otherView: IHosannaView<ViewState>): I2DRectangle;
        getCustomData<T>(): T;
        getNavController(): undefined | INavController;
        getSubView<T extends IHosannaView<ViewState>>(id: string): undefined | T;
        getSubViewRenderer<T extends ISGNGroup>(id: string): undefined | T;
        hideView(view: IHosannaView<ViewState>): void;
        insertChild(
            view: IHosannaView<ViewState>,
            mountTarget: undefined | IHosannaView<ViewState>,
            childIndex?: number,
        ): unknown;
        insertSubView(view: IHosannaView<ViewState>, childIndex?: number): void;
        isInFocusChain(): boolean;
        layoutAt(x: number, y: number, width: number, height: number): void;
        layoutChildren(): void;
        onAppear(): void;
        onBlur(): void;
        onDidAddToAggregateView(view: IAggregateView.IAggregateView): void;
        onDidRemoveFromAggregateView(view: IAggregateView.IAggregateView): void;
        onDisappear(): void;
        onFocus(event?: INextFocusResolutionEvent): void;
        onFocusedChildChange(childId: string): void;
        onKeyEvent(keyEvent: KeyEvent): void;
        onMount(mountTarget: IHosannaView<ViewState>, childIndex?: number): void;
        onTransitionRemoveView(
            transition: AggregateViewTransition.AggregateViewTransition,
        ): void;
        onUnmount(): unknown;
        onWillAddToAggregateView(view: IAggregateView.IAggregateView): void;
        onWillRelease(): void;
        onWillRemoveFromAggregateView(view: IAggregateView.IAggregateView): void;
        onWillReuse(): void;
        present(
            screen: ViewStruct<ViewState>,
            options?: IScreenPresentationOptions,
        ): void;
        removeChild(child: IHosannaView<ViewState>): void;
        removeSubView(view: IHosannaView<ViewState>): void;
        setShowOnScreen(shown: boolean): void;
        setState(state: Partial<ViewState>): void;
        transitionToView(
            view: undefined | IHosannaView<ViewState>,
            animated?: boolean,
            removeSourceWhenComplete?: boolean,
        ): void;
    }

    Hierarchy

    • IHosannaView<ViewState>
      • IAggregateView

    Implemented by

    Index

    Properties

    _cacheKey? _hid? allowViewHibernation? calculatedHeight calculatedWidth calculatedX calculatedY canReceiveFocus children contentId? currentView? id includeInLayout isAutoFocusEnabled isFocused isManagingVisibilityCallbacks isPresented onViewAdded? onViewRemoved? parent? shouldRemoveFromAggregateView subViews tempTransition transitionStyleKey? viewOwner? visible

    Accessors

    renderer transition viewPhase

    Methods

    addChild addSubView containsChild dismiss dispatchAction dispatchAsync dispatchSelection findNextFocusable? getAudioGuideItem getBounds getBoundsInApp getBoundsInParent getCustomData getNavController getSubView getSubViewRenderer hideView insertChild insertSubView isInFocusChain layoutAt layoutChildren onAppear onBlur onDidAddToAggregateView onDidRemoveFromAggregateView onDisappear onFocus onFocusedChildChange? onKeyEvent? onMount onTransitionRemoveView onUnmount onWillAddToAggregateView onWillRelease? onWillRemoveFromAggregateView onWillReuse? present removeChild removeSubView setShowOnScreen setState transitionToView

    Properties

    Optional_cacheKey

    _cacheKey?: string

    Optional_hid

    _hid?: string
    allowViewHibernation?: boolean
    calculatedHeight: number
    calculatedWidth: number
    calculatedX: number
    calculatedY: number
    canReceiveFocus: boolean

    Indicates whether the element can receive focus.

    children: IHosannaView<ViewState>[]
    contentId?: string
    currentView?: IHosannaView<ViewState>

    The current view being navigated.

    id: string
    includeInLayout: boolean
    isAutoFocusEnabled: boolean

    Indicates whether auto-focus is enabled for the view.

    isFocused: boolean

    Indicates whether the view is currently focused.

    isManagingVisibilityCallbacks: boolean

    Indicates whether the view is managing visibility callbacks.

    isPresented: boolean

    Indicates if this view has been prestend in an aggregate View controller

    onViewAdded?: onViewAddedHandler
    onViewRemoved?: onViewRemovedHandler
    parent?: IHosannaView<ViewState>

    The parent focusable element, if any.

    shouldRemoveFromAggregateView: boolean

    Indicates whether the view should be removed from the aggregate view.

    subViews: IHosannaView<ViewState>[]
    tempTransition: undefined | AggregateViewTransition.AggregateViewTransition

    Temporary transition state for the aggregate view.

    transitionStyleKey?: string

    Transition style key for the aggregate view.

    viewOwner?: IHosannaView<ViewState>
    visible: boolean

    Indicates whether the view is visible.

    Accessors

    Methods

    • Children

      Parameters

      • view: IHosannaView<ViewState>
      • mountTarget: undefined | IHosannaView<ViewState>

      Returns unknown

    • Rendererers

      Type Parameters

      • T extends IHosannaView<ViewState>

      Parameters

      • id: string

      Returns undefined | T

    • Parameters

      • view: IHosannaView<ViewState>
      • mountTarget: undefined | IHosannaView<ViewState>
      • OptionalchildIndex: number

      Returns unknown

    • Called when a child element's focus state changes.

      Parameters

      • childId: string

        The ID of the child element.

      Returns void

    • Lifecycle

      Parameters

      • mountTarget: IHosannaView<ViewState>
      • OptionalchildIndex: number

      Returns void

    • Parameters

      • screen: ViewStruct<ViewState>
      • Optionaloptions: IScreenPresentationOptions

      Returns void

    • Transitions to the specified view.

      Parameters

      • view: undefined | IHosannaView<ViewState>

        The view to transition to.

      • Optionalanimated: boolean

        Whether the transition should be animated.

      • OptionalremoveSourceWhenComplete: boolean

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods