ui · thing ·

yuiTree

A yui tree record carrying instanceIdentity, id, surfaceId, nodes, mounted, and related state.

cpumethodsource-examplethinguiyeho

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

external thing yuiTree

Status: source-declared

Fields and methods (28)
yuiTreeInstanceIdentity instanceIdentity
Stores instance identity as yuiTreeInstanceIdentity.
text id
Stores id as text.
text surfaceId
Stores surface id as text.
list of yuiTreeNode nodes
Stores nodes as list of yuiTreeNode.
bool mounted
Stores mounted as bool.
bool disposed
Stores disposed as bool.
int revision
Stores revision as int.
text diagnostic
Stores diagnostic as text.
yuiTree(text id)
Yui tree.
AcquisitionIdentity() returns yuiTreeInstanceIdentity
Acquisition identity. Complete example
MatchesAcquisitionIdentity(yuiTreeInstanceIdentity identity) returns bool
Matches acquisition identity. Complete example
Reject(text operation, text reason) returns bool
Reject. Complete example
Accept()
Accept. Complete example
IndexOf(text nodeId) returns int
Index of. Complete example
IsAlive(text nodeId) returns bool
Is alive. Complete example
ParentChainContains(text startId, text soughtId) returns bool
Parent chain contains. Complete example
AppendNode(text nodeId, text parentId, yuiComponentMetadata component, text properties) returns bool
Append node. Complete example
InsertNode(text nodeId, text parentId, yuiComponentMetadata component, text properties, int order) returns bool
Insert node. Complete example
MoveNode(text nodeId, text parentId, int order) returns bool
Move node. Complete example
RemoveNode(text nodeId) returns bool
Remove node. Complete example
SetProperties(text nodeId, text properties) returns bool
Set properties. Complete example
SetVisible(text nodeId, bool visible) returns bool
Set visible. Complete example
SetEnabled(text nodeId, bool enabled) returns bool
Set enabled. Complete example
MountSurface(text surfaceId) returns bool
Mount surface. Complete example
UnmountSurface() returns bool
Unmount surface. Complete example
DisposeTree() returns bool
Dispose tree. Complete example
RenderTreeReport() returns text
Render tree report. Complete example
RenderLifecycleReport() returns text
Render lifecycle report. Complete example

Use yuiTree

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.
yuiTree sample = yuiTree("id")
Console.Log(Text.From(sample.id))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.AcquisitionIdentity

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

// Acquisition identity.
yuiTree instance = yuiTree("id")
instance.AcquisitionIdentity()
Console.Log("AcquisitionIdentity completed")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.MatchesAcquisitionIdentity

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

yuiTree instance = yuiTree("id")
bool same = instance.MatchesAcquisitionIdentity(instance.AcquisitionIdentity())
Console.Log(Text.From(same))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.Reject

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

// Reject.
yuiTree instance = yuiTree("id")
text argument_operation = "argument operation"
text argument_reason = "argument reason"
bool result = instance.Reject(argument_operation, argument_reason)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.Accept

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

// Accept.
yuiTree instance = yuiTree("id")
instance.Accept()
Console.Log("Accept completed")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.IndexOf

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

// Index of.
yuiTree instance = yuiTree("id")
text argument_nodeId = "argument node Id"
int result = instance.IndexOf(argument_nodeId)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.IsAlive

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 alive.
yuiTree instance = yuiTree("id")
text argument_nodeId = "argument node Id"
bool result = instance.IsAlive(argument_nodeId)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.ParentChainContains

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

// Parent chain contains.
yuiTree instance = yuiTree("id")
text argument_startId = "argument start Id"
text argument_soughtId = "argument sought Id"
bool result = instance.ParentChainContains(argument_startId, argument_soughtId)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.AppendNode

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

// Append node.
yuiTree instance = yuiTree("id")
text argument_nodeId = "argument node Id"
text argument_parentId = "argument parent Id"
yuiComponentMetadata argument_component = yuiComponentMetadata("Nova", "role", "property Schema", "child Rule", "defaults", "example", "design Label", true)
text argument_properties = "argument properties"
bool result = instance.AppendNode(argument_nodeId, argument_parentId, argument_component, argument_properties)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.InsertNode

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

// Insert node.
yuiTree instance = yuiTree("id")
text argument_nodeId = "argument node Id"
text argument_parentId = "argument parent Id"
yuiComponentMetadata argument_component = yuiComponentMetadata("Nova", "role", "property Schema", "child Rule", "defaults", "example", "design Label", true)
text argument_properties = "argument properties"
int argument_order = 1
bool result = instance.InsertNode(argument_nodeId, argument_parentId, argument_component, argument_properties, argument_order)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.MoveNode

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 node.
yuiTree instance = yuiTree("id")
text argument_nodeId = "argument node Id"
text argument_parentId = "argument parent Id"
int argument_order = 1
bool result = instance.MoveNode(argument_nodeId, argument_parentId, argument_order)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.RemoveNode

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

// Remove node.
yuiTree instance = yuiTree("id")
text argument_nodeId = "argument node Id"
bool result = instance.RemoveNode(argument_nodeId)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.SetProperties

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 properties.
yuiTree instance = yuiTree("id")
text argument_nodeId = "argument node Id"
text argument_properties = "argument properties"
bool result = instance.SetProperties(argument_nodeId, argument_properties)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.SetVisible

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 visible.
yuiTree instance = yuiTree("id")
text argument_nodeId = "argument node Id"
bool argument_visible = true
bool result = instance.SetVisible(argument_nodeId, argument_visible)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.SetEnabled

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 enabled.
yuiTree instance = yuiTree("id")
text argument_nodeId = "argument node Id"
bool argument_enabled = true
bool result = instance.SetEnabled(argument_nodeId, argument_enabled)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.MountSurface

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

// Mount surface.
yuiTree instance = yuiTree("id")
text argument_surfaceId = "argument surface Id"
bool result = instance.MountSurface(argument_surfaceId)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.UnmountSurface

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

// Unmount surface.
yuiTree instance = yuiTree("id")
bool result = instance.UnmountSurface()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.DisposeTree

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

// Dispose tree.
yuiTree instance = yuiTree("id")
bool result = instance.DisposeTree()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.RenderTreeReport

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 tree report.
yuiTree instance = yuiTree("id")
text result = instance.RenderTreeReport()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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"

yuiTree.RenderLifecycleReport

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 lifecycle report.
yuiTree instance = yuiTree("id")
text result = instance.RenderLifecycleReport()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuitree"
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/tree-tree.yh:48