Optional
activeThe currently active font object.
Private
activeThe currently active font key or style.
IHosannaView
Optional
audioThis hint can be used in conjunction with the audio guide item
Optional
audioWhether the label can receive focus.
These are the children that are rendered on screen in the tree structure of the view
Whether this is a composite view.
Optional
customWhether to display partial lines.
The ellipsis character to use when text overflows.
Whether to ellipsize on the boundary.
Optional
focusedOptional
fontThe key for the font to use.
Font manager for resolving fonts.
The key for the font style to use.
The horizontal alignment of the label text.
Indicates whether the element is currently focused.
If true, this view has been presented in an AggregateViewController
Whether to show a leading ellipsis.
The spacing between lines.
The maximum number of lines to display.
Private
measurementUtility for measuring text size.
The number of lines to use for the label.
Optional
parentThese are the children that were created in getViews, in a flat strcuture - it contains EVERYTHING that we declared.
Delimiter to use for truncation.
The vertical alignment of the label text.
The IHosannaView subclass that created us in getViews
Indicates whether the navigatable entity is visible.
Characters to use for word breaking.
Whether to wrap text.
Children
Optional
mountTarget: IHosannaView<ViewState>View Creation
Optional
nextState: TBuilds the view and attaches it to the view owner.
Optional
mountTarget: IHosannaView<ViewState>The target to mount the view.
The built view or undefined.
Optional
options: IScreenDismissOptionsOptional
args: Record<string, unknown>Optional
cancellationToken: HsCancellationTokenAsync Support
Optional
args: Record<string, unknown>Optional
callback: AsyncCommandEventCallbackResolves the next focusable element in the given direction.
The event containing details about the focus transition.
The next focusable element, or undefined if none exists.
Audio guide support
Measurement
Rendererers
Hibernates the view and its subviews by releasing native renderers and setting the view phase to Hibernating.
The view to be added as a subview.
index of the child in the parent view, -1 means add to end
Focus
Lays out the label at the specified position and size within its parent.
The x-coordinate.
The y-coordinate.
The width of the parent container.
The height of the parent container.
Measures the size of the label based on its text, font, and wrapping options. Sets the calculatedWidth and calculatedHeight properties.
Called when the navigatable entity is shown.
DO NOT CALL THIS METHOD DIRECTLY DO NOT OVERRIDE IT
Called after the navigatable entity has been added to an aggregate view.
The aggregate view to which the entity has been added.
Called after the navigatable entity has been removed from an aggregate view.
The aggregate view from which the entity has been removed.
Called when the navigatable entity is hidden.
DO NOT CALL THIS METHOD DIRECTLY DO NOT OVERRIDE IT
Handles a key event.
The key event to handle.
True if the key event was handled, false otherwise.
Called before the navigatable entity is added to an aggregate view.
The aggregate view to which the entity will be added.
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.
Called before the navigatable entity is removed from an aggregate view.
The aggregate view from which the entity will be removed.
Presents a new screen in the navigation stack or as a dialog.
The screen to be presented, represented by a ViewStruct<ViewState>
.
Optional
options: IScreenPresentationOptionsOptional presentation options.
If true, the screen will be presented as a dialog.
If true, the screen transition will be animated.
Renders the label with the given state changes. Handles alignment, font resolution, and passes changes to the base render method.
The state changes to apply.
Navigatable View
Wakes up the view and its subviews by reserving native renderers and setting the view phase to Mounted.
LabelView is a primitive view for displaying text labels with rich font, color, alignment, and ellipsis/wrapping options.
Remarks