Hosanna UI API v1.30.2-next
    Preparing search index...

    Interface IDialogView<T>

    Interface for dialog views managed by DialogManagerView.

    interface IDialogView<T> {
        _cacheKey?: string;
        _hid?: string;
        allowViewHibernation?: boolean;
        calculatedHeight: number;
        calculatedWidth: number;
        calculatedX: number;
        calculatedY: number;
        canReceiveFocus: boolean;
        children: IHosannaView<ViewState>[];
        contentId?: string;
        id: string;
        includeInLayout: boolean;
        isFocused: boolean;
        isPresented: boolean;
        onDismissed: DialogDismissedWithValueCallback<T>;
        parent?: IHosannaView<ViewState>;
        selectedValue: T;
        subViews: IHosannaView<ViewState>[];
        viewOwner?: IHosannaView<ViewState>;
        visible: boolean;
        get renderer(): undefined | ISGNGroup;
        set renderer(renderer: undefined | ISGNGroup): void;
        get viewPhase(): ViewPhase;
        set viewPhase(viewPhase: ViewPhase): void;
        addChild(
            view: IHosannaView<ViewState>,
            mountTarget: undefined | IHosannaView<ViewState>,
        ): unknown;
        addSubView(view: IHosannaView<ViewState>): void;
        bringChildInFrontOfChild(
            child: IHosannaView<ViewState>,
            otherChild: IHosannaView<ViewState>,
        ): void;
        bringChildToFront(view: IHosannaView<ViewState>): void;
        canChangeOrientation(event: HosannaOrientationChangeEvent): boolean;
        containsChild(child: IHosannaView<ViewState>): boolean;
        dismiss(options?: IScreenDismissOptions): void;
        dispatchAction<T>(options: IActionOptions<T>): void;
        dispatchAsync(
            command: string,
            args?: Record<string, unknown>,
            callback?: AsyncCommandEventCallback,
            taskId?: string,
        ): 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;
        insertChild(
            view: IHosannaView<ViewState>,
            mountTarget: undefined | IHosannaView<ViewState>,
            childIndex?: number,
        ): unknown;
        insertChildAfterOtherChild(
            child: IHosannaView<ViewState>,
            otherChild: IHosannaView<ViewState>,
        ): void;
        insertChildBeforeOtherChild(
            child: IHosannaView<ViewState>,
            otherChild: IHosannaView<ViewState>,
        ): void;
        insertSubView(view: IHosannaView<ViewState>, childIndex?: number): void;
        isInFocusChain(): boolean;
        layoutAt(x: number, y: number, width: number, height: number): void;
        layoutChildren(): void;
        onAppear(): void;
        onAppearAgain(): void;
        onBlur(): void;
        onDidAddToAggregateView(view: IAggregateView.IAggregateView): void;
        onDidAppearInAggregateView(view: IAggregateView.IAggregateView): void;
        onDidChangeOrientation(event: HosannaOrientationChangeEvent): void;
        onDidReappearInAggregateView(view: IAggregateView.IAggregateView): void;
        onDidRemoveFromAggregateView(view: IAggregateView.IAggregateView): void;
        onDisappear(): void;
        onDisappearFromAggregateView(view: IAggregateView.IAggregateView): void;
        onFirstAppear(): void;
        onFocus(event?: INextFocusResolutionEvent): void;
        onFocusedChildChange(childId: string): void;
        onInputEvent(inputEvent: HsInputEvent): void;
        onMount(mountTarget: IHosannaView<ViewState>, childIndex?: number): void;
        onUnmount(): unknown;
        onWillAddToAggregateView(view: IAggregateView.IAggregateView): void;
        onWillChangeOrientation(event: HosannaOrientationChangeEvent): 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;
        requestFocusedChild(target: ChildFocusTarget, childId?: string): void;
        sendChildBehindOtherChild(
            child: IHosannaView<ViewState>,
            otherChild: IHosannaView<ViewState>,
        ): void;
        sendChildToBack(view: IHosannaView<ViewState>): void;
        setChildIndex(view: IHosannaView<ViewState>, newIndex: number): void;
        setShowOnScreen(shown: boolean): void;
        setState(state: Partial<T>): void;
    }

    Type Parameters

    • T

    Hierarchy

    • IHosannaView<ViewState>
      • IDialogView
    Index

    Properties

    _cacheKey? _hid? allowViewHibernation? calculatedHeight calculatedWidth calculatedX calculatedY canReceiveFocus children contentId? id includeInLayout isFocused isPresented onDismissed parent? selectedValue subViews viewOwner? visible

    Accessors

    renderer viewPhase

    Methods

    addChild addSubView bringChildInFrontOfChild bringChildToFront canChangeOrientation containsChild dismiss dispatchAction dispatchAsync dispatchSelection findNextFocusable? getAudioGuideItem getBounds getBoundsInApp getBoundsInParent getCustomData getNavController getSubView getSubViewRenderer insertChild insertChildAfterOtherChild insertChildBeforeOtherChild insertSubView isInFocusChain layoutAt layoutChildren onAppear onAppearAgain onBlur onDidAddToAggregateView onDidAppearInAggregateView onDidChangeOrientation onDidReappearInAggregateView onDidRemoveFromAggregateView onDisappear onDisappearFromAggregateView onFirstAppear onFocus onFocusedChildChange? onInputEvent? onMount onUnmount onWillAddToAggregateView onWillChangeOrientation onWillRelease? onWillRemoveFromAggregateView onWillReuse? present removeChild removeSubView requestFocusedChild sendChildBehindOtherChild sendChildToBack setChildIndex setShowOnScreen setState

    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
    id: string
    includeInLayout: boolean
    isFocused: boolean

    Indicates whether the element is currently focused.

    isPresented: boolean

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

    onDismissed: DialogDismissedWithValueCallback<T>

    Callback invoked when the dialog is dismissed with a value.

    parent?: IHosannaView<ViewState>

    The parent focusable element, if any.

    selectedValue: T

    The selected value from the dialog.

    subViews: IHosannaView<ViewState>[]
    viewOwner?: IHosannaView<ViewState>
    visible: boolean

    Indicates whether the navigatable entity is visible.

    Accessors

    Methods

    • Children

      Parameters

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

      Returns unknown

    • View Creation

      Parameters

      • view: IHosannaView<ViewState>

      Returns void

    • Parameters

      • child: IHosannaView<ViewState>
      • otherChild: IHosannaView<ViewState>

      Returns void

    • Parameters

      • view: IHosannaView<ViewState>

      Returns void

    • Parameters

      • event: HosannaOrientationChangeEvent

      Returns boolean

    • Parameters

      • child: IHosannaView<ViewState>

      Returns boolean

    • Parameters

      • Optionaloptions: IScreenDismissOptions

      Returns void

    • Type Parameters

      • T

      Parameters

      Returns void

    • Resolves the next focusable element in the given direction.

      Parameters

      Returns undefined | IFocusable | NextViewFocus

      The next focusable element, or undefined if none exists.

    • Measurement

      Returns I2DRectangle

    • Returns I2DRectangle

    • Parameters

      • otherView: IHosannaView<ViewState>

      Returns I2DRectangle

    • Type Parameters

      • T

      Returns T

    • Returns undefined | INavController

    • Rendererers

      Type Parameters

      • T extends IHosannaView<ViewState>

      Parameters

      • id: string

      Returns undefined | T

    • Type Parameters

      Parameters

      • id: string

      Returns undefined | T

    • Parameters

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

      Returns unknown

    • Parameters

      • child: IHosannaView<ViewState>
      • otherChild: IHosannaView<ViewState>

      Returns void

    • Parameters

      • child: IHosannaView<ViewState>
      • otherChild: IHosannaView<ViewState>

      Returns void

    • Parameters

      • view: IHosannaView<ViewState>
      • OptionalchildIndex: number

      Returns void

    • Focus

      Returns boolean

    • Parameters

      • x: number
      • y: number
      • width: number
      • height: number

      Returns void

    • Returns void

    • Returns void

      Prefer onDidAppearInAggregateView / onDidReappearInAggregateView when the view is shown via an aggregate transition. The framework still invokes this for other paths (e.g. root view, tab propagation) until those are migrated.

      Called when the navigatable entity is shown.

    • Called when this view becomes the visible top again after having been covered by another screen on the same NavController (same transition finish as onAppear, immediately after it).

      Returns void

      Prefer overriding onDidReappearInAggregateView; default implementation chains from it.

    • Called when the element loses focus.

      Returns void

    • Called after the navigatable entity has been added to an aggregate view.

      Parameters

      Returns void

    • Parameters

      • event: HosannaOrientationChangeEvent

      Returns void

    • Called when this view becomes the visible top again after having been covered by another screen on the same NavController. Default implementation delegates to onAppear and onAppearAgain.

      Parameters

      Returns void

    • Called after the navigatable entity has been removed from an aggregate view.

      Parameters

      Returns void

    • Returns void

      Prefer onDisappearFromAggregateView when leaving an aggregate context during a transition. The framework still invokes this for other paths until migrated.

      Called when the navigatable entity is hidden.

    • Called when this view is hidden during an aggregate transition or via BaseAggregateView.hideView. Default implementation delegates to onDisappear.

      Parameters

      Returns void

    • Called when this view becomes the visible top of a NavController stack for the first time for that controller (same transition finish as onAppear, immediately after it).

      Returns void

      Prefer overriding onDidAppearInAggregateView; default implementation chains from it.

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

      Parameters

      • childId: string

        The ID of the child element.

      Returns void

    • Handles an input event.

      Parameters

      Returns void

    • Lifecycle

      Parameters

      • mountTarget: IHosannaView<ViewState>
      • OptionalchildIndex: number

      Returns void

    • Returns unknown

    • Called before the navigatable entity is added to an aggregate view.

      Parameters

      Returns void

    • Parameters

      • event: HosannaOrientationChangeEvent

      Returns void

    • Returns void

    • Called before the navigatable entity is removed from an aggregate view.

      Parameters

      Returns void

    • Returns void

    • Parameters

      • screen: ViewStruct<ViewState>
      • Optionaloptions: IScreenPresentationOptions

      Returns void

    • Parameters

      • child: IHosannaView<ViewState>

      Returns void

    • Parameters

      • view: IHosannaView<ViewState>

      Returns void

    • Parameters

      • target: ChildFocusTarget
      • OptionalchildId: string

      Returns void

    • Parameters

      • child: IHosannaView<ViewState>
      • otherChild: IHosannaView<ViewState>

      Returns void

    • Parameters

      • view: IHosannaView<ViewState>

      Returns void

    • Parameters

      • view: IHosannaView<ViewState>
      • newIndex: number

      Returns void

    • Navigatable View

      Parameters

      • shown: boolean

      Returns void

    • Parameters

      • state: Partial<T>

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    addChildaddSubViewbringChildInFrontOfChildbringChildToFrontcanChangeOrientationcontainsChilddismissdispatchActiondispatchAsyncdispatchSelectionfindNextFocusablegetAudioGuideItemgetBoundsgetBoundsInAppgetBoundsInParentgetCustomDatagetNavControllergetSubViewgetSubViewRendererinsertChildinsertChildAfterOtherChildinsertChildBeforeOtherChildinsertSubViewisInFocusChainlayoutAtlayoutChildrenonAppearonAppearAgainonBluronDidAddToAggregateViewonDidAppearInAggregateViewonDidChangeOrientationonDidReappearInAggregateViewonDidRemoveFromAggregateViewonDisappearonDisappearFromAggregateViewonFirstAppearonFocusonFocusedChildChangeonInputEventonMountonUnmountonWillAddToAggregateViewonWillChangeOrientationonWillReleaseonWillRemoveFromAggregateViewonWillReusepresentremoveChildremoveSubViewrequestFocusedChildsendChildBehindOtherChildsendChildToBacksetChildIndexsetShowOnScreensetState