ui · thing ·

yuiFocusModel

A yui focus model record carrying entries, scopes, focusedNodeId, previousFocusedNodeId, activeScopeId, and related state.

cpumethodsource-examplethinguiyeho

Build YUI's reusable control, layout, interaction, text, accessibility, and retained-rendering models.

external thing yuiFocusModel

Status: source-declared

Fields and methods (26)
list of yuiFocusEntry entries
Stores entries as list of yuiFocusEntry.
list of yuiFocusScope scopes
Stores scopes as list of yuiFocusScope.
text focusedNodeId
Stores focused node id as text.
text previousFocusedNodeId
Stores previous focused node id as text.
text activeScopeId
Stores active scope id as text.
bool focusVisible
Stores focus visible as bool.
text diagnostic
Stores diagnostic as text.
yuiFocusModel()
Yui focus model.
EntryIndex(text nodeId) returns int
Entry index. Complete example
ScopeIndex(text scopeId) returns int
Scope index. Complete example
AddEntry(yuiFocusEntry entry) returns bool
Add entry. Complete example
AddScope(yuiFocusScope scope) returns bool
Add scope. Complete example
EntryAvailable(yuiTree tree, int index) returns bool
Entry available. Complete example
SetFocus(yuiTree tree, text nodeId, bool keyboardVisible) returns bool
Set focus. Complete example
ClearFocus()
Clear focus. Complete example
Reconcile(yuiTree tree)
Reconcile. Complete example
CandidateAfter(yuiTree tree, int currentIndex, int direction) returns int
Candidate after. Complete example
BoundaryCandidate(yuiTree tree, int direction) returns int
Boundary candidate. Complete example
ActiveScopeWraps() returns bool
Active scope wraps. Complete example
MoveTab(yuiTree tree, int direction) returns bool
Move tab. Complete example
DirectionCandidate(yuiTree tree, text direction) returns int
Direction candidate. Complete example
MoveDirection(yuiTree tree, text direction) returns bool
Move direction. Complete example
EnterScope(yuiTree tree, text scopeId) returns bool
Enter scope. Complete example
LeaveScope(yuiTree tree) returns bool
Leave scope. Complete example
HandleEscape(yuiTree tree) returns bool
Handle escape. Complete example
RenderFocusReport() returns text
Render focus report. Complete example

Use yuiFocusModel

A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.

cpu · source-example · type checked

using ui

// Build YUI's reusable control, layout, interaction, text, accessibility, and retained-rendering models.
yuiFocusModel sample = yuiFocusModel()
Console.Log(Text.From(sample.focusedNodeId))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.EntryIndex

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Entry index.
yuiFocusModel instance = yuiFocusModel()
text argument_nodeId = "argument node Id"
int result = instance.EntryIndex(argument_nodeId)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.ScopeIndex

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Scope index.
yuiFocusModel instance = yuiFocusModel()
text argument_scopeId = "argument scope Id"
int result = instance.ScopeIndex(argument_scopeId)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.AddEntry

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Add entry.
yuiFocusModel instance = yuiFocusModel()
yuiFocusEntry argument_entry = yuiFocusEntry("node Id", "scope Id", 1, 1, 1, 1, 1, true)
bool result = instance.AddEntry(argument_entry)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.AddScope

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Add scope.
yuiFocusModel instance = yuiFocusModel()
yuiFocusScope argument_scope = yuiFocusScope("id", "root Node Id", true, true)
bool result = instance.AddScope(argument_scope)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.EntryAvailable

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Entry available.
yuiFocusModel instance = yuiFocusModel()
yuiTree argument_tree = yuiTree("id")
int argument_index = 1
bool result = instance.EntryAvailable(argument_tree, argument_index)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.SetFocus

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Set focus.
yuiFocusModel instance = yuiFocusModel()
yuiTree argument_tree = yuiTree("id")
text argument_nodeId = "argument node Id"
bool argument_keyboardVisible = true
bool result = instance.SetFocus(argument_tree, argument_nodeId, argument_keyboardVisible)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.ClearFocus

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Clear focus.
yuiFocusModel instance = yuiFocusModel()
instance.ClearFocus()
Console.Log("ClearFocus completed")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.Reconcile

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Reconcile.
yuiFocusModel instance = yuiFocusModel()
yuiTree argument_tree = yuiTree("id")
instance.Reconcile(argument_tree)
Console.Log("Reconcile completed")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.CandidateAfter

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Candidate after.
yuiFocusModel instance = yuiFocusModel()
yuiTree argument_tree = yuiTree("id")
int argument_currentIndex = 1
int argument_direction = 1
int result = instance.CandidateAfter(argument_tree, argument_currentIndex, argument_direction)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.BoundaryCandidate

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Boundary candidate.
yuiFocusModel instance = yuiFocusModel()
yuiTree argument_tree = yuiTree("id")
int argument_direction = 1
int result = instance.BoundaryCandidate(argument_tree, argument_direction)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.ActiveScopeWraps

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Active scope wraps.
yuiFocusModel instance = yuiFocusModel()
bool result = instance.ActiveScopeWraps()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.MoveTab

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Move tab.
yuiFocusModel instance = yuiFocusModel()
yuiTree argument_tree = yuiTree("id")
int argument_direction = 1
bool result = instance.MoveTab(argument_tree, argument_direction)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.DirectionCandidate

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Direction candidate.
yuiFocusModel instance = yuiFocusModel()
yuiTree argument_tree = yuiTree("id")
text argument_direction = "argument direction"
int result = instance.DirectionCandidate(argument_tree, argument_direction)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.MoveDirection

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Move direction.
yuiFocusModel instance = yuiFocusModel()
yuiTree argument_tree = yuiTree("id")
text argument_direction = "argument direction"
bool result = instance.MoveDirection(argument_tree, argument_direction)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.EnterScope

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Enter scope.
yuiFocusModel instance = yuiFocusModel()
yuiTree argument_tree = yuiTree("id")
text argument_scopeId = "argument scope Id"
bool result = instance.EnterScope(argument_tree, argument_scopeId)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.LeaveScope

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Leave scope.
yuiFocusModel instance = yuiFocusModel()
yuiTree argument_tree = yuiTree("id")
bool result = instance.LeaveScope(argument_tree)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.HandleEscape

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Handle escape.
yuiFocusModel instance = yuiFocusModel()
yuiTree argument_tree = yuiTree("id")
bool result = instance.HandleEscape(argument_tree)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiFocusModel.RenderFocusReport

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Render focus report.
yuiFocusModel instance = yuiFocusModel()
text result = instance.RenderFocusReport()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuifocusmodel"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"
Notes and source

Package presence and a declaration do not establish support on every host. Host services need their platform and lifecycle setup.

yeho/packages/ui/interaction-focus.yh:64