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

    Class GridGroupView

    GridGroupView is a composite view for displaying children in a grid layout.

    • Supports configurable columns, alignment, and spacing.
    • Handles focus navigation and layout measurement.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    __isMemoizedStateValid _cacheKey _hid _isInFocusChain _rendereredTranslation activeStyleViewStatus addItemSpacingAfterChild aggregateView audioGuideHint? audioGuideItem? calculatedHeight calculatedWidth calculatedX calculatedY canReceiveFocus children childrenChanged clippingRect columns compositeView customData? defaultValues eventHandlers focusedChildId? focusId gridHeight gridWidth height horizAlignment id includeInLayout initialFocusId instancePool isFocused isLayoutDirty isPresented isSkeleton isWaking itemSpacing layoutChildrenList nextViewId nodePool opacity parent? partialRendererHibernatedState rotation rowHeights rowWidths scale scaleRotateCenter scrollablePositionX scrollablePositionY spacingConstants staticType styleRegistry subViews subViewsChanged translation vertAlignment viewOwner viewStatus visible width xOffset yOffset

    Accessors

    renderer viewPhase

    Methods

    addChild addChildren addRendererToParentViewRenderer addSubView applyIdsToViewStructs applyInitialState applyLayoutStateToNativeRenderer applyStateChanges buildView canMeasureBounds clearErrorByErrorField clearErrors configureAudioGuideItem containsChild createDataEvent dismiss dispatch dispatchAction dispatchAsync dispatchSelection findNextFocusable findNextFocusableView findNextFocusableViewByDirection getAudioGuideItem getBounds getBoundsInApp getBoundsInParent getChangedField getChildView getCustomData getField getFlattenedStructs getFlattenedStructsById getGridHeight getGridMeasuredDimensions getGridWidth getNavController getObservableField getSpacingConstants getSubView getSubViewRenderer getXOffset getYOffset hibernateView inflateViewStructs insertChild insertSubView invalidateLayout invalidateParentLayout isDescendantOf isInFocusChain layoutAt layoutChildren measure notifyOnFocusedChildChange onAppear onBlur onDidAddToAggregateView onDidRemoveFromAggregateView onDisappear onFocus onKeyEvent onMount onUnmount onWillAddToAggregateView onWillApplyStateChanges onWillRemoveFromAggregateView performViewManagerLayoutChildren present reconcileChildren recycle registerControlWithErrorMessage registerControlWithKnownError release removeChild removeSubView render setError setField setLayoutField setObservableField setShowOnScreen setState showDialog unobserveObservableObjects wakeView

    Constructors

    Properties

    __isMemoizedStateValid

    __isMemoizedStateValid: boolean = false

    _cacheKey

    _cacheKey: string = ''

    _hid

    _hid: string

    _isInFocusChain

    _isInFocusChain: boolean = false

    _rendereredTranslation

    _rendereredTranslation: [number, number] = ...
    activeStyleViewStatus: ViewStatus = ViewStatus.Normal
    addItemSpacingAfterChild: boolean = false

    Whether to add item spacing after the last child in each row.

    aggregateView: undefined | IAggregateView.IAggregateView

    IHosannaView

    audioGuideHint?: string = ''

    This hint can be used in conjunction with the audio guide item

    audioGuideItem?: string | IAudioGuideItem
    calculatedHeight: number = 0
    calculatedWidth: number = 0
    calculatedX: number = 0
    calculatedY: number = 0
    canReceiveFocus: boolean = true

    Indicates whether the element can receive focus.

    children: BaseView.BaseView<ViewState, ISGNGroup>[] = []

    These are the children that are rendered on screen in the tree structure of the view

    childrenChanged: boolean = false
    clippingRect: number[] = ...
    columns: number = 3

    Number of columns in the grid.

    compositeView: boolean = true

    Indicdates whether the view is a focus group which means it can have a focused child Otherwise it will be focused itself

    customData?: unknown
    defaultValues: Partial<GridGroupState> = {}
    eventHandlers: Record<string, Function> = {}
    focusedChildId?: string
    focusId: string = ''
    gridHeight: number = 0

    Total height of the grid.

    gridWidth: number = 0

    Total width of the grid.

    height: number = 0
    horizAlignment: SGHorizontalAlignment = SGHorizontalAlignment.Left

    Horizontal alignment of the grid content.

    id: string = ''
    includeInLayout: boolean = true
    initialFocusId: string = ''
    instancePool: IInstancePool
    isFocused: boolean = false

    Indicates whether the element is currently focused.

    isLayoutDirty: boolean = false
    isPresented: boolean = false

    If true, this view has been presented in an AggregateViewController

    isSkeleton: boolean = false
    isWaking: boolean = false
    itemSpacing: number = 0

    Spacing between items, as a number or [horizontal, vertical] tuple.

    layoutChildrenList: BaseView.BaseView<ViewState, ISGNGroup>[] = []

    List of child views to be laid out in the grid.

    nextViewId: number = 0
    nodePool: INodePool
    opacity: number = 1.0
    parent?: IHosannaView<ViewState> = undefined
    partialRendererHibernatedState: Partial<GridGroupState> = {}
    rotation: number = 0
    rowHeights: number[] = []

    Heights of each row in the grid.

    rowWidths: number[] = []

    Widths of each row in the grid.

    scale: number[] = ...
    scaleRotateCenter: number[] = ...
    scrollablePositionX: undefined | number = undefined
    scrollablePositionY: undefined | number = undefined
    spacingConstants: [number, number] = ...

    Cached spacing constants [horizontal, vertical].

    staticType: ViewStaticType = ViewStaticType.None
    styleRegistry: IStyleRegistry
    subViews: BaseView.BaseView<ViewState, ISGNGroup>[] = []

    These are the children that were created in getViews, in a flat strcuture - it contains EVERYTHING that we declared.

    subViewsChanged: boolean = false
    translation: number[] = ...
    vertAlignment: SGVerticalAlignment = SGVerticalAlignment.Top

    Vertical alignment of the grid content.

    viewOwner: IHosannaView<ViewState>

    The IHosannaView subclass that created us in getViews

    viewStatus: ViewStatus = ViewStatus.Normal
    visible: boolean = true

    Indicates whether the navigatable entity is visible.

    width: number = 0
    xOffset: number = 0

    Horizontal offset for grid alignment.

    yOffset: number = 0

    Vertical offset for grid alignment.

    Accessors

    Methods

    • Builds the view and attaches it to the view owner.

      Parameters

      • struct: ViewStruct<ViewState>
      • OptionalmountTarget: IHosannaView<ViewState>

        The target to mount the view.

      • childIndex: number = -1

      Returns undefined | IHosannaView<ViewState>

      The built view or undefined.

    • Parameters

      • nextStructs: ViewStruct<ViewState>[]
      • map: Record<string, ViewStruct<ViewState>> = {}
      • idList: { childIndex: number; id: string }[] = []

      Returns {
          idList: { childIndex: number; id: string }[];
          mappedNextStructs: Record<string, ViewStruct<ViewState>>;
      }

    • Calculates the widths and heights of each row, and the total grid dimensions.

      Returns {
          gridHeight: number;
          gridWidth: number;
          rowHeights: number[];
          rowWidths: number[];
      }

      An object containing rowWidths, rowHeights, gridHeight, and gridWidth.

    • Lays out the grid group view at the specified position.

      Parameters

      • x: number

        The x-coordinate.

      • y: number

        The y-coordinate.

      • parentWidth: number

        The width of the parent container.

      • parentHeight: number

        The height of the parent container.

      Returns void

    • Presents a new screen in the navigation stack or as a dialog.

      Parameters

      • screen: ViewStruct<ViewState>

        The screen to be presented, represented by a ViewStruct<ViewState>.

      • Optionaloptions: IScreenPresentationOptions

        Optional presentation options.

        • isDialog

          If true, the screen will be presented as a dialog.

        • animated

          If true, the screen transition will be animated.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    addChildaddChildrenaddRendererToParentViewRendereraddSubViewapplyIdsToViewStructsapplyInitialStateapplyLayoutStateToNativeRendererapplyStateChangesbuildViewcanMeasureBoundsclearErrorByErrorFieldclearErrorsconfigureAudioGuideItemcontainsChildcreateDataEventdismissdispatchdispatchActiondispatchAsyncdispatchSelectionfindNextFocusablefindNextFocusableViewfindNextFocusableViewByDirectiongetAudioGuideItemgetBoundsgetBoundsInAppgetBoundsInParentgetChangedFieldgetChildViewgetCustomDatagetFieldgetFlattenedStructsgetFlattenedStructsByIdgetGridHeightgetGridMeasuredDimensionsgetGridWidthgetNavControllergetObservableFieldgetSpacingConstantsgetSubViewgetSubViewRenderergetXOffsetgetYOffsethibernateViewinflateViewStructsinsertChildinsertSubViewinvalidateLayoutinvalidateParentLayoutisDescendantOfisInFocusChainlayoutAtlayoutChildrenmeasurenotifyOnFocusedChildChangeonAppearonBluronDidAddToAggregateViewonDidRemoveFromAggregateViewonDisappearonFocusonKeyEventonMountonUnmountonWillAddToAggregateViewonWillApplyStateChangesonWillRemoveFromAggregateViewperformViewManagerLayoutChildrenpresentreconcileChildrenrecycleregisterControlWithErrorMessageregisterControlWithKnownErrorreleaseremoveChildremoveSubViewrendersetErrorsetFieldsetLayoutFieldsetObservableFieldsetShowOnScreensetStateshowDialogunobserveObservableObjectswakeView