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

    Interface ICollectionViewFocusManager

    Interface for a collection view focus manager. Handles rendering and updating focus info and animations.

    interface ICollectionViewFocusManager {
        applyCellViewStatus(
            rowIndex: number,
            itemIndex: number,
            focused: boolean,
            isFootprint?: boolean,
        ): void;
        beginLongPressFocusTransition(): void;
        beginRapidPressFocusTransition(): boolean;
        completeLongPressFocusTransition(force?: boolean): boolean;
        completeRapidPressFocusTransition(): boolean;
        endLongPressFocusTransition(): void;
        onFocusIndicatorLayoutSettled(): boolean;
        renderNextFocusInfo(): void;
        renderWhileMovingBetweenItems(percent: number): void;
        reset(): void;
        setAndRenderFocusInfo(info: undefined | IFocusInfo): void;
        setFocusIndicatorSuppressed(suppressed: boolean): void;
        setNextFocusInfo(info: IFocusInfo): void;
        speakAudioGuideItemForCurrentFocus(force?: boolean): void;
        speakSupplementaryAudioGuideItem(item: undefined | IAudioGuideItem): void;
    }

    Implemented by

    Index

    Methods

    applyCellViewStatus beginLongPressFocusTransition? beginRapidPressFocusTransition? completeLongPressFocusTransition? completeRapidPressFocusTransition? endLongPressFocusTransition? onFocusIndicatorLayoutSettled? renderNextFocusInfo renderWhileMovingBetweenItems reset setAndRenderFocusInfo setFocusIndicatorSuppressed? setNextFocusInfo speakAudioGuideItemForCurrentFocus speakSupplementaryAudioGuideItem

    Methods

    • Applies the cell view status.

      Parameters

      • rowIndex: number
      • itemIndex: number
      • focused: boolean
      • OptionalisFootprint: boolean

      Returns void

    • Starts the active strategy's gesture-level long-press lifecycle.

      Returns void

    • Starts the active strategy's lifecycle for overlapping rapid presses.

      Returns boolean

    • Completes the active strategy's long-press traversal, optionally at a held boundary.

      Parameters

      • Optionalforce: boolean

      Returns boolean

    • Completes the active strategy's rapid-press traversal after the queue settles.

      Returns boolean

    • Marks the active strategy's long-press traversal ready to finish after settling.

      Returns void

    • Notifies the active transition strategy after CollectionView rendered settled row geometry.

      Returns boolean

    • Renders the next focus info.

      Returns void

    • Renders focus state while moving between items.

      Parameters

      • percent: number

      Returns void

    • Resets focus manager state to initial values (e.g. when collection view is cleared).

      Returns void

    • Sets and renders the focus info.

      Parameters

      Returns void

    • Suppresses or restores focus indicator visibility without changing committed focus.

      Parameters

      • suppressed: boolean

      Returns void

    • Sets the next focus info for animation or transition.

      Parameters

      Returns void

    • Speaks the currently focused row and item.

      Parameters

      • Optionalforce: boolean

      Returns void

    • Speaks one whole supplementary-view announcement.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods