ui · thing ·

yuiVirtualCollection

A yui virtual collection record carrying kind, itemCount, itemExtent, overscanRows, crossAxisCount, and related state.

cpumethodsource-examplethinguiyeho

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

external thing yuiVirtualCollection

Status: source-declared

Fields and methods (25)
text kind
Stores kind as text.
int itemCount
Stores item count as int.
int itemExtent
Stores item extent as int.
int overscanRows
Stores overscan rows as int.
int crossAxisCount
Stores cross axis count as int.
text stableKeyPrefix
Stores stable key prefix as text.
int realizedStart
Stores realized start as int.
int realizedEnd
Stores realized end as int.
int realizedCount
Stores realized count as int.
int peakRealizedCount
Stores peak realized count as int.
int recycledCount
Stores recycled count as int.
int generation
Stores generation as int.
text selectedKey
Stores selected key as text.
text focusedKey
Stores focused key as text.
text source
Stores source as text.
text diagnostic
Stores diagnostic as text.
yuiVirtualCollection(text kind, int itemCount, int itemExtent, int overscanRows, text stableKeyPrefix, text source)
Yui virtual collection.
ValidationIssue() returns text
Validation issue. Complete example
SetCrossAxisCount(int count) returns bool
Set cross axis count. Complete example
StableKey(int index) returns text
Stable key. Complete example
Realize(int offset, int viewportExtent) returns yuiVirtualRange
Realize. Complete example
IsRealized(int index) returns bool
Is realized. Complete example
SelectKey(text stableKey) returns bool
Select key. Complete example
FocusKey(text stableKey) returns bool
Focus key. Complete example
RenderReport() returns text
Render report. Complete example

Use yuiVirtualCollection

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.
yuiVirtualCollection sample = yuiVirtualCollection("kind", 1, 1, 1, "stable Key Prefix", "example")
Console.Log(Text.From(sample.kind))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuivirtualcollection"
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"

yuiVirtualCollection.ValidationIssue

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

// Validation issue.
yuiVirtualCollection instance = yuiVirtualCollection("kind", 1, 1, 1, "stable Key Prefix", "example")
text result = instance.ValidationIssue()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuivirtualcollection"
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"

yuiVirtualCollection.SetCrossAxisCount

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 cross axis count.
yuiVirtualCollection instance = yuiVirtualCollection("kind", 1, 1, 1, "stable Key Prefix", "example")
int argument_count = 1
bool result = instance.SetCrossAxisCount(argument_count)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuivirtualcollection"
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"

yuiVirtualCollection.StableKey

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

// Stable key.
yuiVirtualCollection instance = yuiVirtualCollection("kind", 1, 1, 1, "stable Key Prefix", "example")
int argument_index = 1
text result = instance.StableKey(argument_index)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuivirtualcollection"
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"

yuiVirtualCollection.Realize

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

// Realize.
yuiVirtualCollection instance = yuiVirtualCollection("kind", 1, 1, 1, "stable Key Prefix", "example")
int argument_offset = 1
int argument_viewportExtent = 1
yuiVirtualRange result = instance.Realize(argument_offset, argument_viewportExtent)
Console.Log("Inspect result in your debugger")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuivirtualcollection"
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"

yuiVirtualCollection.IsRealized

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

// Is realized.
yuiVirtualCollection instance = yuiVirtualCollection("kind", 1, 1, 1, "stable Key Prefix", "example")
int argument_index = 1
bool result = instance.IsRealized(argument_index)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuivirtualcollection"
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"

yuiVirtualCollection.SelectKey

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

// Select key.
yuiVirtualCollection instance = yuiVirtualCollection("kind", 1, 1, 1, "stable Key Prefix", "example")
text argument_stableKey = "argument stable Key"
bool result = instance.SelectKey(argument_stableKey)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuivirtualcollection"
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"

yuiVirtualCollection.FocusKey

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

// Focus key.
yuiVirtualCollection instance = yuiVirtualCollection("kind", 1, 1, 1, "stable Key Prefix", "example")
text argument_stableKey = "argument stable Key"
bool result = instance.FocusKey(argument_stableKey)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuivirtualcollection"
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"

yuiVirtualCollection.RenderReport

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 report.
yuiVirtualCollection instance = yuiVirtualCollection("kind", 1, 1, 1, "stable Key Prefix", "example")
text result = instance.RenderReport()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuivirtualcollection"
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/layout-virtual.yh:25