Google is committed to advancing racial equity for Black communities. See how.

SemanticsConfiguration

class SemanticsConfiguration : SemanticsPropertyReceiver, Iterable<Entry<SemanticsPropertyKey<*>, Any?>>
kotlin.Any
   ↳ androidx.ui.core.semantics.SemanticsConfiguration

Describes the semantic information associated with the owning component

The information provided in the configuration is used to to generate the semantics tree.

Summary

Public constructors

Describes the semantic information associated with the owning component

Public methods
operator Boolean

SemanticsConfiguration

Returns an exact copy of this configuration.

Boolean
equals(other: Any?)

operator T

Retrieves the value for the given property, if one has been set.

T
getOrElse(key: SemanticsPropertyKey<T>, defaultValue: () -> T)

T?
getOrElseNullable(key: SemanticsPropertyKey<T>, defaultValue: () -> T?)

Int

Iterator<Entry<SemanticsPropertyKey<*>, Any?>>

Unit
set(key: SemanticsPropertyKey<T>, value: T)

String

Extension functions
From androidx.ui.core.semantics
T?

Inherited extension functions
From androidx.ui.semantics
Unit
SemanticsPropertyReceiver.ScrollTo(label: String? = null, action: (x: Float, y: Float) -> Boolean)

This function adds the SemanticsActions.ScrollTo to the SemanticsPropertyReceiver.

Unit
SemanticsPropertyReceiver.onClick(label: String? = null, action: () -> Boolean)

This function adds the SemanticsActions.OnClick to the SemanticsPropertyReceiver.

Unit
SemanticsPropertyReceiver.scrollBackward(label: String? = null, action: () -> Boolean)

This function adds the SemanticsActions.ScrollBackward to the SemanticsPropertyReceiver.

Unit
SemanticsPropertyReceiver.scrollForward(label: String? = null, action: () -> Boolean)

This function adds the SemanticsActions.ScrollForward to the SemanticsPropertyReceiver.

Unit
SemanticsPropertyReceiver.setProgress(label: String? = null, action: (progress: Float) -> Boolean)

This function adds the SemanticsActions.SetProgress to the SemanticsPropertyReceiver.

Properties
Boolean

Whether this configuration is empty.

Boolean

Whether the semantic information provided by the owning component and all of its descendants should be treated as one logical entity.

Inherited extension properties
From androidx.ui.semantics
AccessibilityAction<(x: Float, y: Float) -> Boolean>

Action to scroll to a specified position.

String

Developer-set content description of the semantics node.

String

Developer-set state description of the semantics node.

AccessibilityRangeInfo

The node is a range with current value.

List<CustomAccessibilityAction>

Custom actions which are defined by app developers.

Boolean

Whether this semantics node is enabled.

Boolean

Whether this semantics node is hidden.

AccessibilityAction<() -> Boolean>

Action to be performed when the node is clicked.

Boolean

Whether this semantics node represents a Popup.

AccessibilityAction<() -> Boolean>

Action to scroll the content backward.

AccessibilityAction<() -> Boolean>

Action to scroll the content forward.

AccessibilityAction<(progress: Float) -> Boolean>

Action to set slider progress.

String

Test tag attached to this semantics node.

AnnotatedString

Text of the semantics node.

From androidx.ui.foundation.semantics
Boolean

Whether this element is a Dialog.

Boolean

Whether this element is in a group from which only a single item can be selected at any given time (such as a radio group)

Boolean

Whether this element is selected (out of a list of possible selections).

ToggleableState

The state of a toggleable component.

From androidx.ui.text
ImeAction

Contains the IME action provided by the node.

Boolean

Return whether the component supports input methods.

Public constructors

<init>

SemanticsConfiguration()

Describes the semantic information associated with the owning component

The information provided in the configuration is used to to generate the semantics tree.

Public methods

contains

operator fun <T> contains(key: SemanticsPropertyKey<T>): Boolean

copy

fun copy(): SemanticsConfiguration

Returns an exact copy of this configuration.

equals

fun equals(other: Any?): Boolean

get

operator fun <T> get(key: SemanticsPropertyKey<T>): T

Retrieves the value for the given property, if one has been set. If a value has not been set, throws IllegalStateException

getOrElse

fun <T> getOrElse(
    key: SemanticsPropertyKey<T>,
    defaultValue: () -> T
): T

getOrElseNullable

fun <T> getOrElseNullable(
    key: SemanticsPropertyKey<T>,
    defaultValue: () -> T?
): T?

hashCode

fun hashCode(): Int

iterator

fun iterator(): Iterator<Entry<SemanticsPropertyKey<*>, Any?>>

set

fun <T> set(
    key: SemanticsPropertyKey<T>,
    value: T
): Unit

toString

fun toString(): String

Properties

isEmpty

val isEmpty: Boolean

Whether this configuration is empty.

An empty configuration doesn't contain any semantic information that it wants to contribute to the semantics tree.

isMergingSemanticsOfDescendants

var isMergingSemanticsOfDescendants: Boolean

Whether the semantic information provided by the owning component and all of its descendants should be treated as one logical entity.

If set to true, the descendants of the owning component's SemanticsNode will merge their semantic information into the SemanticsNode representing the owning component.