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

    Interface ICollectionView

    Interface for a collection view, extending IHosannaView. Provides methods and properties for focus, data source, and cell access.

    interface ICollectionView {
        _cacheKey?: string;
        _hid?: string;
        allowViewHibernation?: boolean;
        calculatedHeight: number;
        calculatedWidth: number;
        calculatedX: number;
        calculatedY: number;
        canReceiveFocus: boolean;
        children: IHosannaView<ViewState>[];
        container: ISGNGroup;
        contentId?: string;
        focusedItemIndex: number;
        focusedRowIndex: number;
        id: string;
        includeInLayout: boolean;
        isFocused: boolean;
        isPresented: boolean;
        parent?: IHosannaView<ViewState>;
        speed: number;
        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;
        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;
        getCellForIndex(
            rowIndex: number,
            itemIndex: number,
        ): undefined | ICollectionViewCell;
        getCustomData<T>(): T;
        getDataSourceItemForIndex(
            rowIndex: number,
            itemIndex: number,
        ): undefined | IIdentifiable;
        getDataSourceRowForIndex(
            rowIndex: number,
        ): undefined | ICollectionViewDataSourceRow<any, IIdentifiable>;
        getFocusedDataSourceItem(): undefined | IIdentifiable;
        getFocusedDataSourceRow(): | undefined
        | ICollectionViewDataSourceRow<any, IIdentifiable>;
        getFocusedRow(): undefined | IBaseCollectionViewRow;
        getFocusInfo(rowIndex: number, itemIndex: number): undefined | IFocusInfo;
        getFocusManager(): ICollectionViewFocusManager;
        getNavController(): undefined | INavController;
        getRowForIndex(rowIndex: number): undefined | IBaseCollectionViewRow;
        getRows(): IBaseCollectionViewRow[];
        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;
        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;
        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;
    }

    Hierarchy

    • IHosannaView<ViewState>
      • ICollectionView

    Implemented by

    Index

    Properties

    _cacheKey? _hid? allowViewHibernation? calculatedHeight calculatedWidth calculatedX calculatedY canReceiveFocus children container contentId? focusedItemIndex focusedRowIndex id includeInLayout isFocused isPresented parent? speed subViews viewOwner? visible

    Accessors

    renderer viewPhase

    Methods

    addChild addSubView containsChild dismiss dispatchAction dispatchAsync dispatchSelection findNextFocusable? getAudioGuideItem getBounds getBoundsInApp getBoundsInParent getCellForIndex getCustomData getDataSourceItemForIndex getDataSourceRowForIndex getFocusedDataSourceItem getFocusedDataSourceRow getFocusedRow getFocusInfo getFocusManager getNavController getRowForIndex getRows getSubView getSubViewRenderer insertChild insertSubView isInFocusChain layoutAt layoutChildren onAppear onBlur onDidAddToAggregateView onDidRemoveFromAggregateView onDisappear onFocus onFocusedChildChange? onKeyEvent? onMount onUnmount onWillAddToAggregateView onWillRelease? onWillRemoveFromAggregateView onWillReuse? present removeChild removeSubView 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>[]
    container: ISGNGroup

    The root container group for the collection view.

    contentId?: string
    focusedItemIndex: number

    The currently focused item index within the focused row.

    focusedRowIndex: number

    The currently focused row index.

    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

    parent?: IHosannaView<ViewState>

    The parent focusable element, if any.

    speed: number

    The scroll speed for the collection view.

    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

    • 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

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods