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

    Class ComboBoxView<T, R>

    ComboBoxView is a composite view for displaying a dropdown combo box.

    • Renders a button and a dropdown list of selectable items.
    • Supports custom rendering, focus management, and selection events.
    ComboBox({
      items: this.appInfo.languages,
      isDropdownOpen: false,
      width: this.formWidth,
    })
      .selectedIndex(this.appInfo.languages.findIndex((lang) => lang.id === this.sharedProfile.languageId))
      .onSelectionChange((event) => this.sharedProfile.languageId = event.item.id)

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    __isMemoizedStateValid _cacheKey _hid _isInFocusChain _rendereredTranslation activeStyleViewStatus aggregateView audioGuideHint? audioGuideItem? backgroundColor backgroundUri buttonFocusColor buttonFocusUri buttonListGap buttonTitleFontKey calculatedHeight calculatedWidth calculatedX calculatedY canReceiveFocus children childrenChanged clippingRect color compositeView customData? defaultValues dropdownPosition eventHandlers focusedChildId? focusId height horizPadding iconColor iconUri id includeInLayout initialFocusId instancePool isButtonFocusShown isDropdownOpen isFocused isLayoutDirty isPresented isSkeleton isWaking itemAloneFocusUri itemBottomFocusUri itemFocusColor itemMiddleFocusUri items itemsCount itemTopFocusUri listBackgroundColor listBackgroundImageUri nextViewId nodePool onSelectionChange? opacity parent? partialRendererHibernatedState placeholder rotation scale scaleRotateCenter scrollablePositionX scrollablePositionY selectedIndex staticType styleRegistry subViews subViewsChanged translation viewOwner viewStatus visible width

    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 getButtonText getChangedField getChildView getCustomData getDropdownTranslation getField getFlattenedStructs getFlattenedStructsById getItemFocusUri getNavController getObservableField getSubView getSubViewRenderer hibernateView inflateViewStructs insertChild insertSubView invalidateLayout invalidateParentLayout isDescendantOf isFocusedOrHasFocusedChild isInFocusChain layoutAt layoutChildren measure notifyOnFocusedChildChange onAppear onBlur onCardsContainerKeyEventHandler 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 speakAudioGuideItem 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
    aggregateView: undefined | IAggregateView.IAggregateView

    IHosannaView

    audioGuideHint?: string = ''

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

    audioGuideItem?: string | IAudioGuideItem
    backgroundColor: string = ''

    Background color for the button.

    backgroundUri: string = ''

    Background image URI for the button.

    buttonFocusColor: string = ''

    Focus color for the button.

    buttonFocusUri: string = ''

    Focus image URI for the button.

    buttonListGap: number = 9

    Gap between button and list.

    buttonTitleFontKey: string = 'theme.fonts.text-bold-24'

    Font key for the button title.

    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[] = ...
    color: string = ''

    Text color for the button.

    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<T> = {}
    dropdownPosition: DropdownPosition = DropdownPosition.Bottom

    Dropdown position (top or bottom).

    eventHandlers: Record<string, Function> = {}
    focusedChildId?: string
    focusId: string = ''
    height: number = 0
    horizPadding: { left: number; right: number } = ...

    Horizontal padding for the button.

    iconColor: string = ''

    Icon color for the button.

    iconUri: string = ''

    Icon image URI for the button.

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

    Whether the dropdown is open.

    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
    itemAloneFocusUri: string = ''

    Focus image URI for a single item.

    itemBottomFocusUri: string = ''

    Focus image URI for the bottom item.

    itemFocusColor: string = ''

    Focus color for items.

    itemMiddleFocusUri: string = ''

    Focus image URI for a middle item.

    items: IComboBoxItem[] = []

    The items to display in the dropdown.

    itemsCount: number = 0

    Number of items in the dropdown.

    itemTopFocusUri: string = ''

    Focus image URI for the top item.

    listBackgroundColor: string = ''

    Background color for the dropdown list.

    listBackgroundImageUri: string = ''

    Background image URI for the dropdown list.

    nextViewId: number = 0
    nodePool: INodePool
    onSelectionChange?: ViewEventHandler<ComboBoxEvent>

    Event handler called when selection changes.

    opacity: number = 1.0
    parent?: IHosannaView<ViewState> = undefined
    partialRendererHibernatedState: Partial<T> = {}
    placeholder: string = ''

    Placeholder text for the button.

    rotation: number = 0
    scale: number[] = ...
    scaleRotateCenter: number[] = ...
    scrollablePositionX: undefined | number = undefined
    scrollablePositionY: undefined | number = undefined
    selectedIndex: undefined | number = undefined

    The selected item index.

    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[] = ...
    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

    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>>;
      }

    • 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
    __isMemoizedStateValid_cacheKey_hid_isInFocusChain_rendereredTranslationactiveStyleViewStatusaggregateViewaudioGuideHintaudioGuideItembackgroundColorbackgroundUributtonFocusColorbuttonFocusUributtonListGapbuttonTitleFontKeycalculatedHeightcalculatedWidthcalculatedXcalculatedYcanReceiveFocuschildrenchildrenChangedclippingRectcolorcompositeViewcustomDatadefaultValuesdropdownPositioneventHandlersfocusedChildIdfocusIdheighthorizPaddingiconColoriconUriidincludeInLayoutinitialFocusIdinstancePoolisButtonFocusShownisDropdownOpenisFocusedisLayoutDirtyisPresentedisSkeletonisWakingitemAloneFocusUriitemBottomFocusUriitemFocusColoritemMiddleFocusUriitemsitemsCountitemTopFocusUrilistBackgroundColorlistBackgroundImageUrinextViewIdnodePoolonSelectionChangeopacityparentpartialRendererHibernatedStateplaceholderrotationscalescaleRotateCenterscrollablePositionXscrollablePositionYselectedIndexstaticTypestyleRegistrysubViewssubViewsChangedtranslationviewOwnerviewStatusvisiblewidth
    Accessors
    Methods
    addChildaddChildrenaddRendererToParentViewRendereraddSubViewapplyIdsToViewStructsapplyInitialStateapplyLayoutStateToNativeRendererapplyStateChangesbuildViewcanMeasureBoundsclearErrorByErrorFieldclearErrorsconfigureAudioGuideItemcontainsChildcreateDataEventdismissdispatchdispatchActiondispatchAsyncdispatchSelectionfindNextFocusablefindNextFocusableViewfindNextFocusableViewByDirectiongetAudioGuideItemgetBoundsgetBoundsInAppgetBoundsInParentgetButtonTextgetChangedFieldgetChildViewgetCustomDatagetDropdownTranslationgetFieldgetFlattenedStructsgetFlattenedStructsByIdgetItemFocusUrigetNavControllergetObservableFieldgetSubViewgetSubViewRendererhibernateViewinflateViewStructsinsertChildinsertSubViewinvalidateLayoutinvalidateParentLayoutisDescendantOfisFocusedOrHasFocusedChildisInFocusChainlayoutAtlayoutChildrenmeasurenotifyOnFocusedChildChangeonAppearonBluronCardsContainerKeyEventHandleronDidAddToAggregateViewonDidRemoveFromAggregateViewonDisappearonFocusonKeyEventonMountonUnmountonWillAddToAggregateViewonWillApplyStateChangesonWillRemoveFromAggregateViewperformViewManagerLayoutChildrenpresentreconcileChildrenrecycleregisterControlWithErrorMessageregisterControlWithKnownErrorreleaseremoveChildremoveSubViewrendersetErrorsetFieldsetLayoutFieldsetObservableFieldsetShowOnScreensetStateshowDialogspeakAudioGuideItemunobserveObservableObjectswakeView