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

    Class MaskView<T, R>

    MaskView is a composite view that applies a mask to its child views.

    • Supports configurable mask offset, size, and URI.
    • Handles layout and measurement of children.
    Mask([
      Image({
        id: 'poster1',
        visible: this.isPoster1Visible,
        failedBitmapUri: this.backgroundUri,
        onLoadStatusChange: (event) =>
          this.onPosterLoadStatusChange(event.status as SGImageLoadStatus, event.view.id),
      }),
      Image({
        id: 'poster2',
        failedBitmapUri: this.backgroundUri,
        visible: this.isPoster2Visible,
        onLoadStatusChange: (event) =>
          this.onPosterLoadStatusChange(event.status as SGImageLoadStatus, event.view.id),
      }),
    ])
      .maskUri(this.maskUri)
      .maskSize([this.imageWidth, this.imageHeight])
      .scale(this.maskScale)
      .clippingRect(this.maskClippingRect)

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    __isMemoizedStateValid _cacheKey _hid _isInFocusChain activeAnimation? activeStyleViewStatus aggregateView appConfig audioGuideHint? audioGuideItem? calculatedHeight calculatedWidth calculatedX calculatedY canReceiveFocus children childrenChanged clippingRect compositeView customData? defaultValues eventHandlers focusedChildId? focusId height hosannaDevice id includeInLayout initialFocusId instancePool isFocused isLayoutDirty isPresented isSkeleton isWaking keyboardAvoidance maskOffset? maskScale maskSize? maskUri? nativeGlass nextViewId nodePool opacity parent? partialRendererHibernatedState platform rotation scale scaleRotateCenter scrollablePositionX scrollablePositionY shapeStyle? staticType subViews subViewsChanged translation viewOwner viewStatus visible warnedUnresolvedShapeStyle width

    Accessors

    _rendereredTranslation renderer viewPhase

    Methods

    addChild addChildren addRendererToParentViewRenderer addSubView animateViews applyDefaultRokuMaskSize applyIdsToViewStructs applyInitialState applyLayoutStateToNativeRenderer applyStateChanges bringChildInFrontOfChild bringChildToFront buildView canChangeOrientation canMeasureBounds clearErrorByErrorField clearErrors configureAudioGuideItem containsChild createDataEvent dismiss dispatch dispatchAction dispatchAsync dispatchSelection findNextFocusable findNextFocusableView findNextFocusableViewByDirection getAnimationPropsForStateProperty getAudioGuideItem getBounds getBoundsInApp getBoundsInParent getChangedField getChildView getCustomData getField getFlattenedStructs getFlattenedStructsById getNavController getObservableField getPointInLocalCoordinates getSubView getSubViewRenderer hibernateView inflateViewStructs insertChild insertChildAfterOtherChild insertChildBeforeOtherChild insertSubView invalidateLayout invalidateParentLayout isDescendantOf isInFocusChain layoutAt layoutChildren markStateDirtyForViewManager measure notifyOnFocusedChildChange onAppear onAppearAgain onBlur onDidAddToAggregateView onDidAppearInAggregateView onDidChangeOrientation onDidReappearInAggregateView onDidRemoveFromAggregateView onDisappear onDisappearFromAggregateView onFirstAppear onFocus onInputEvent onMount onUnmount onWillAddToAggregateView onWillApplyStateChanges onWillChangeOrientation onWillRemoveFromAggregateView onWillReuse performViewManagerLayoutChildren present reconcileChildren recycle registerControlWithErrorMessage registerControlWithKnownError release removeChild removeSubView render requestFocusedChild resolveFocusEntryTarget resolveShapeStyleUri sendChildBehindOtherChild sendChildToBack setChildIndex 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
    activeAnimation?: HosannaViewAnimator

    If present, an animation currently targeting this view (or its subviews).

    activeStyleViewStatus: ViewStatus = ViewStatus.Normal
    aggregateView: undefined | IAggregateView.IAggregateView

    IHosannaView

    appConfig: IAppConfig
    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[] = ...
    compositeView: boolean = false

    Indicates this is not a composite view.

    customData?: unknown
    defaultValues: Partial<T> = {}
    eventHandlers: Record<string, Function> = {}
    focusedChildId?: string
    focusId: string = ''
    height: number = 0
    hosannaDevice: IHosannaDevice

    The Hosanna device instance, used for device-specific properties.

    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
    keyboardAvoidance: "none" | "auto" = 'auto'

    Automatic keyboard avoidance opt-out. When a software keyboard appears, the framework translates the visible screen to keep the editing input in view; set 'none' on the screen or the input to disable. Plain field (not reactive) — checked at keyboard-show time.

    maskOffset?: [number, number]
    maskScale: number = ...

    The mask scale factor based on the device's resolution.

    maskSize?: [number, number]

    The [width, height] size for the mask image.

    maskUri?: string

    The URI for the mask image.

    nativeGlass: undefined | SGNativeGlassEffect = undefined
    nextViewId: number = 0
    nodePool: INodePool
    opacity: number = 1.0
    parent?: IHosannaView<ViewState> = undefined
    partialRendererHibernatedState: Partial<T> = {}
    platform: PlatformType = ...

    The platform type, used for specific rendering logic.

    rotation: number = 0
    scale: number[] = ...
    scaleRotateCenter: number[] = ...
    scrollablePositionX: undefined | number = undefined
    scrollablePositionY: undefined | number = undefined
    shapeStyle?: string

    Shape style key (theme.shapes entry) used as the mask source. The style must declare mask: true (and a reference width/height): on Roku its launch-compiled flat mask image is assigned to maskUri and scaled to the mask rect by maskSize; other platforms draw the style's geometry natively at any size. Takes precedence over a declared maskUri, which stays as the fallback when the key does not resolve.

    staticType: ViewStaticType = ViewStaticType.None
    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.

    warnedUnresolvedShapeStyle: boolean = false
    width: number = 0

    Accessors

    _rendereredTranslation

    • get _rendereredTranslation(): [number, number]

      Returns [number, number]

    • set _rendereredTranslation(value: [number, number]): void

      Parameters

      • value: [number, number]

      Returns void

    • get renderer(): undefined | R

      Returns undefined | R

    • set renderer(value: undefined | R): void

      Parameters

      • value: undefined | R

      Returns void

    • get viewPhase(): ViewPhase

      Returns ViewPhase

    • set viewPhase(phase: ViewPhase): void

      Parameters

      Returns void

    Methods

    • Children

      Parameters

      • child: IHosannaView<ViewState>
      • OptionalmountTarget: IHosannaView<ViewState>

      Returns void

    • Parameters

      • children: IHosannaView<ViewState>[]

      Returns void

    • Parameters

      • parent: undefined | IHosannaView<ViewState>
      • childIndex: number = -1

      Returns void

    • View Creation

      Parameters

      • view: IHosannaView<ViewState>

      Returns void

    • Roku parity default: native platforms fall back to the view rect when no maskSize is declared, but the SG MaskGroup falls back to the mask bitmap's own size — for a shapeStyle mask that is the style's reference size, not the view. Mirror the native fallback by sizing the mask to the laid-out view rect (maskSize scaling is exactly what makes the launch-compiled full-size mask image fit any rect). A declared maskSize always wins.

      Returns void

    • Parameters

      • nextViewStructs: undefined | ViewStruct<ViewState>[]
      • parentId: string = ""
      • level: number = 0

      Returns void

    • Parameters

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

      Returns void

    • Parameters

      • child: IHosannaView<ViewState>

      Returns void

    • 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

      • _event: HosannaOrientationChangeEvent

      Returns boolean

    • Parameters

      • errorField: IDebugErrorFieldMap

      Returns void

    • Parameters

      • child: IHosannaView<ViewState>

      Returns boolean

    • Parameters

      • Optionaloptions: IScreenDismissOptions

      Returns void

    • Measurement

      Returns I2DRectangle

    • Parameters

      • otherView: IHosannaView<ViewState>

      Returns I2DRectangle

    • Type Parameters

      • T extends IHosannaView<ViewState>

      Parameters

      • id: string

      Returns undefined | T

    • Type Parameters

      • K extends string | number | symbol

      Parameters

      • field: K

      Returns any

    • Parameters

      • nextStructs: ViewStruct<ViewState>[]

      Returns ViewStruct<ViewState>[]

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

    • Returns undefined | INavController

    • Parameters

      • point: { x: number; y: number }

      Returns { x: number; y: number }

    • Rendererers

      Type Parameters

      • T extends IHosannaView<ViewState>

      Parameters

      • id: string
      • isDeepSearch: boolean = false

      Returns undefined | T

    • Hibernates the view and its subviews by releasing native renderers and setting the view phase to Hibernating.

      Returns void

    • Parameters

      • nextViewStructs: ViewStruct<ViewState>[]

      Returns void

    • Parameters

      • child: IHosannaView<ViewState>
      • OptionalmountTarget: IHosannaView<ViewState>
      • index: number = -1

      Returns void

    • Parameters

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

      Returns void

    • Parameters

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

      Returns void

    • Parameters

      • view: IHosannaView<ViewState>

        The view to be added as a subview.

      • index: number = -1

        index of the child in the parent view, -1 means add to end

      Returns void

    • Parameters

      • view: IHosannaView<ViewState>

      Returns boolean

    • Parameters

      • x: number
      • y: number
      • parentWidth: number
      • parentHeight: number

      Returns void

    • Measures the mask group and its children, updating layout properties.

      Returns void

    • Returns void

      Prefer BaseView.onDidAppearInAggregateView / BaseView.onDidReappearInAggregateView when shown via an aggregate transition. The framework still invokes this for other paths until migrated.

      IHosannaView.onAppear

    • 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.

    • DO NOT CALL THIS METHOD DIRECTLY DO NOT OVERRIDE IT

      Returns void

    • Parameters

      • _event: HosannaOrientationChangeEvent

      Returns void

    • Returns void

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

      IHosannaView.onDisappear

    • 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.

    • DO NOT CALL THIS METHOD DIRECTLY DO NOT OVERRIDE IT

      Returns void

    • Lifecycle

      Parameters

      • parent: IHosannaView<ViewState> | BaseApp.BaseApp
      • childIndex: number = -1

      Returns void

    • This method is called before applying state changes to the view. It is used to perform any necessary preparations before the state changes are applied.

      Returns void

    • Parameters

      • _event: HosannaOrientationChangeEvent

      Returns void

    • Called by InstancePool.get() before a pooled instance is handed out. Restores the view to a construction-equivalent state so that stale lifecycle data (focus, viewStatus, old text, dirty flags, etc.) from the previous owner does not bleed into the new one.

      Class-default

      Returns void

      values (captured on first construction into the InstancePool per-class-name registry) are placed into pendingState with state left empty — matching a freshly-constructed view. This guarantees that every subsequent setField call (in applyInitialState) detects a difference against the empty state and pushes the value into pendingState, so applyLayoutStateToNativeRenderer applies ALL layout props (opacity, visible, translation, …) to the newly-acquired renderer even when the logical value equals the class default.

    • 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

    • Parameters

      • nextStructs: ViewStruct<ViewState>[]

      Returns void

    • IReusable implementation

      Parameters

      • initialState: T

      Returns void

    • Parameters

      • message: string
      • errorField: IDebugErrorFieldMap

      Returns void

    • Parameters

      • message: string
      • errorField: IDebugErrorFieldMap

      Returns void

    • Parameters

      • child: IHosannaView<ViewState>

      Returns void

    • Parameters

      • view: IHosannaView<ViewState>

      Returns void

    • Parameters

      • changes: Partial<T>

      Returns void

    • Sets which direct child this composite prefers on the next focus cascade, or moves focus to that child if this view is already in the focus chain.

      • First / Last: first or last direct child in children order with canReceiveFocus && visible.
      • Default: clears focusedChildId only (next cascade uses getInitialFocusId()); does not call setFocus.
      • Specific: same behavior as setFocusedSubview for a known child id.

      Parameters

      • target: ChildFocusTarget
      • OptionalchildId: string

      Returns void

    • Roku: the compiled flat mask image uri for shapeStyle (theme.compiledShapes[key].maskUri, pre-rendered at launch — see ShapeLoader/CompileShapes), or the declared maskUri when the key is cleared/unresolved or the style is not a mask source.

      Returns undefined | string

    • Parameters

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

      Returns void

    • Parameters

      • child: IHosannaView<ViewState>

      Returns void

    • Changes the visual z-order of a child by moving it to a new index. Higher indices render on top. Updates both the children array and the renderer. Requires removeChild before insertChild because the SG node's insertChild always adds (splices in) and does not move; calling it on an already-present child would duplicate.

      Parameters

      • child: IHosannaView<ViewState>
      • newIndex: number

      Returns void

    • Parameters

      • errorObj: IDebugErrorObject

      Returns void

    • Type Parameters

      • K extends string | number | symbol

      Parameters

      • field: K
      • value: T[K]

      Returns void

    • Type Parameters

      • K extends string | number | symbol

      Parameters

      • field: K
      • value: T[K]

      Returns void

    • Parameters

      • key: string
      • newVal: unknown

      Returns void

    • Navigatable View

      Parameters

      • shown: boolean

      Returns void

    • Parameters

      • state: Partial<T>

      Returns void

    • Parameters

      • dialog: ViewStruct<ViewState>

      Returns void

    • Wakes up the view and its subviews by reserving native renderers and setting the view phase to Mounted.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    addChildaddChildrenaddRendererToParentViewRendereraddSubViewanimateViewsapplyDefaultRokuMaskSizeapplyIdsToViewStructsapplyInitialStateapplyLayoutStateToNativeRendererapplyStateChangesbringChildInFrontOfChildbringChildToFrontbuildViewcanChangeOrientationcanMeasureBoundsclearErrorByErrorFieldclearErrorsconfigureAudioGuideItemcontainsChildcreateDataEventdismissdispatchdispatchActiondispatchAsyncdispatchSelectionfindNextFocusablefindNextFocusableViewfindNextFocusableViewByDirectiongetAnimationPropsForStatePropertygetAudioGuideItemgetBoundsgetBoundsInAppgetBoundsInParentgetChangedFieldgetChildViewgetCustomDatagetFieldgetFlattenedStructsgetFlattenedStructsByIdgetNavControllergetObservableFieldgetPointInLocalCoordinatesgetSubViewgetSubViewRendererhibernateViewinflateViewStructsinsertChildinsertChildAfterOtherChildinsertChildBeforeOtherChildinsertSubViewinvalidateLayoutinvalidateParentLayoutisDescendantOfisInFocusChainlayoutAtlayoutChildrenmarkStateDirtyForViewManagermeasurenotifyOnFocusedChildChangeonAppearonAppearAgainonBluronDidAddToAggregateViewonDidAppearInAggregateViewonDidChangeOrientationonDidReappearInAggregateViewonDidRemoveFromAggregateViewonDisappearonDisappearFromAggregateViewonFirstAppearonFocusonInputEventonMountonUnmountonWillAddToAggregateViewonWillApplyStateChangesonWillChangeOrientationonWillRemoveFromAggregateViewonWillReuseperformViewManagerLayoutChildrenpresentreconcileChildrenrecycleregisterControlWithErrorMessageregisterControlWithKnownErrorreleaseremoveChildremoveSubViewrenderrequestFocusedChildresolveFocusEntryTargetresolveShapeStyleUrisendChildBehindOtherChildsendChildToBacksetChildIndexsetErrorsetFieldsetLayoutFieldsetObservableFieldsetShowOnScreensetStateshowDialogunobserveObservableObjectswakeView