SemanticsNode

Artifact: androidx.compose.ui:ui

View Source

Added in 1.0.0

Common/AllAndroid/JVM

• Cmn

  class SemanticsNode

---

A list of key/value pairs associated with a layout node or its subtree.

Each SemanticsNode takes its id and initial key/value list from the outermost modifier on one layout node. It also contains the "collapsed" configuration of any other semantics modifiers on the same layout node, and if "mergeDescendants" is specified and enabled, also the "merged" configuration of its subtree.

Summary

Public functions
Int	getAlignmentLinePosition(alignmentLine: AlignmentLine) Returns the position of an alignment line, or AlignmentLine.Unspecified if the line is not provided.	Cmn

Public properties
Rect	boundsInRoot The bounding box for this node relative to the root of this Compose hierarchy, with clipping applied.	Cmn
Rect	boundsInWindow The bounding box for this node relative to the window, with clipping applied.	Cmn
List<SemanticsNode>	children Contains the children in inverse hit test order (i.e. paint order).	Cmn
SemanticsConfiguration	config The list of semantics properties of this node.	Cmn
Int	id For newer AccessibilityNodeInfo-based integration test frameworks, it can be matched in the extras with key "androidx.compose.ui.semantics.id"	Cmn
Boolean	isRoot Whether this SemanticNode is the root of a tree or not	Cmn
LayoutInfo	layoutInfo The LayoutInfo that this is associated with.	Cmn
Boolean	mergingEnabled	Cmn
SemanticsNode?	parent The parent of this node in the tree.	Cmn
Offset	positionInRoot The position of this node relative to the root of this Compose hierarchy, with no clipping applied	Cmn
Offset	positionInWindow The position of this node relative to the window, with no clipping applied	Cmn
Offset	positionOnScreen The position of this node relative to the screen, with no clipping applied	Cmn
RootForTest?	root The root this node is attached to.	Cmn
IntSize	size The size of the bounding box for this node, with no clipping applied	Cmn
Rect	touchBoundsInRoot The rectangle of the touchable area.	Cmn

Public functions

getAlignmentLinePosition

Cmn

Added in 1.0.0

fun getAlignmentLinePosition(alignmentLine: AlignmentLine): Int

Returns the position of an alignment line, or AlignmentLine.Unspecified if the line is not provided.

Public properties

boundsInRoot

Cmn

Added in 1.0.0

val boundsInRoot: Rect

The bounding box for this node relative to the root of this Compose hierarchy, with clipping applied. To get the bounds with no clipping applied, use Rect(positionInRoot, size.toSize())

boundsInWindow

Cmn

Added in 1.0.0

val boundsInWindow: Rect

The bounding box for this node relative to the window, with clipping applied. To get the bounds with no clipping applied, use PxBounds(positionInWindow, size.toSize())

children

Cmn

Added in 1.0.0

val children: List<SemanticsNode>

Contains the children in inverse hit test order (i.e. paint order).

Note that if mergingEnabled and mergeDescendants are both true, then there are no children (except those that are themselves mergeDescendants).

config

Cmn

Added in 1.0.0

val config: SemanticsConfiguration

The list of semantics properties of this node.

This includes all properties attached as modifiers to the current layout node. In addition, if mergeDescendants and mergingEnabled are both true, then it also includes the semantics properties of descendant nodes.

id

Cmn

Added in 1.0.0

val id: Int

For newer AccessibilityNodeInfo-based integration test frameworks, it can be matched in the extras with key "androidx.compose.ui.semantics.id"

isRoot

Cmn

Added in 1.0.0

val isRoot: Boolean

Whether this SemanticNode is the root of a tree or not

layoutInfo

Cmn

Added in 1.0.0

val layoutInfo: LayoutInfo

The LayoutInfo that this is associated with.

mergingEnabled

Cmn

Added in 1.0.0

val mergingEnabled: Boolean

parent

Cmn

Added in 1.0.0

val parent: SemanticsNode?

The parent of this node in the tree.

positionInRoot

Cmn

Added in 1.0.0

val positionInRoot: Offset

The position of this node relative to the root of this Compose hierarchy, with no clipping applied

positionInWindow

Cmn

Added in 1.0.0

val positionInWindow: Offset

The position of this node relative to the window, with no clipping applied

positionOnScreen

Cmn

Added in 1.7.0

val positionOnScreen: Offset

The position of this node relative to the screen, with no clipping applied

root

Cmn

Added in 1.0.0

val root: RootForTest?

The root this node is attached to.

size

Cmn

Added in 1.0.0

val size: IntSize

The size of the bounding box for this node, with no clipping applied

touchBoundsInRoot

Cmn

Added in 1.1.0

val touchBoundsInRoot: Rect

The rectangle of the touchable area.

If this is a clickable region, this is the rectangle that accepts touch input. This can be larger than size when the layout is less than ViewConfiguration.minimumTouchTargetSize