{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

SemanticsProperties

public static class SemanticsProperties


General semantics properties, mainly used for accessibility and testing.

Each of these is intended to be set by the respective SemanticsPropertyReceiver extension instead of used directly.

Summary

Public fields

static @NonNull SemanticsProperties

Public methods

final @NonNull SemanticsPropertyKey<@NonNull CollectionInfo>
final @NonNull SemanticsPropertyKey<@NonNull CollectionItemInfo>
final @NonNull SemanticsPropertyKey<@NonNull List<@NonNull String>>
final @NonNull SemanticsPropertyKey<Unit>
final @NonNull SemanticsPropertyKey<@NonNull AnnotatedString>
final @NonNull SemanticsPropertyKey<@NonNull String>
final @NonNull SemanticsPropertyKey<@NonNull Boolean>
final @NonNull SemanticsPropertyKey<Unit>
final @NonNull SemanticsPropertyKey<@NonNull ScrollAxisRange>
final @NonNull SemanticsPropertyKey<@NonNull ImeAction>
final @NonNull SemanticsPropertyKey<@NonNull Function1<@NonNull Object, @NonNull Integer>>
final @NonNull SemanticsPropertyKey<Unit>
final @NonNull SemanticsPropertyKey<@NonNull Boolean>
final @NonNull SemanticsPropertyKey<Unit>
final @NonNull SemanticsPropertyKey<Unit>
final @NonNull SemanticsPropertyKey<@NonNull Boolean>
final @NonNull SemanticsPropertyKey<@NonNull LiveRegionMode>
final @NonNull SemanticsPropertyKey<@NonNull String>
final @NonNull SemanticsPropertyKey<Unit>
final @NonNull SemanticsPropertyKey<@NonNull ProgressBarRangeInfo>
final @NonNull SemanticsPropertyKey<@NonNull Role>

The type of user interface element.

final @NonNull SemanticsPropertyKey<Unit>
final @NonNull SemanticsPropertyKey<@NonNull Boolean>
final @NonNull SemanticsPropertyKey<@NonNull String>
final @NonNull SemanticsPropertyKey<@NonNull String>
final @NonNull SemanticsPropertyKey<@NonNull List<@NonNull AnnotatedString>>
final @NonNull SemanticsPropertyKey<@NonNull TextRange>
final @NonNull SemanticsPropertyKey<@NonNull ToggleableState>
final @NonNull SemanticsPropertyKey<@NonNull Float>
final @NonNull SemanticsPropertyKey<@NonNull ScrollAxisRange>

Public fields

INSTANCE

public static @NonNull SemanticsProperties INSTANCE

Public methods

getCollectionInfo

public final @NonNull SemanticsPropertyKey<@NonNull CollectionInfogetCollectionInfo()
See also
collectionInfo

getCollectionItemInfo

public final @NonNull SemanticsPropertyKey<@NonNull CollectionItemInfogetCollectionItemInfo()

getContentDescription

public final @NonNull SemanticsPropertyKey<@NonNull List<@NonNull String>> getContentDescription()

getDisabled

public final @NonNull SemanticsPropertyKey<UnitgetDisabled()
See also
disabled

getEditableText

public final @NonNull SemanticsPropertyKey<@NonNull AnnotatedStringgetEditableText()
See also
editableText

getError

public final @NonNull SemanticsPropertyKey<@NonNull StringgetError()
See also
error

getFocused

public final @NonNull SemanticsPropertyKey<@NonNull BooleangetFocused()
See also
focused

getHeading

public final @NonNull SemanticsPropertyKey<UnitgetHeading()
See also
heading

getHorizontalScrollAxisRange

public final @NonNull SemanticsPropertyKey<@NonNull ScrollAxisRangegetHorizontalScrollAxisRange()

getImeAction

public final @NonNull SemanticsPropertyKey<@NonNull ImeActiongetImeAction()
See also
imeAction

getIndexForKey

public final @NonNull SemanticsPropertyKey<@NonNull Function1<@NonNull Object, @NonNull Integer>> getIndexForKey()
See also
indexForKey

getInvisibleToUser

public final @NonNull SemanticsPropertyKey<UnitgetInvisibleToUser()
See also
invisibleToUser

getIsContainer

public final @NonNull SemanticsPropertyKey<@NonNull BooleangetIsContainer()
See also
isContainer

getIsDialog

public final @NonNull SemanticsPropertyKey<UnitgetIsDialog()
See also
dialog

getIsPopup

public final @NonNull SemanticsPropertyKey<UnitgetIsPopup()
See also
popup

getIsTraversalGroup

public final @NonNull SemanticsPropertyKey<@NonNull BooleangetIsTraversalGroup()
See also
isTraversalGroup

getLiveRegion

public final @NonNull SemanticsPropertyKey<@NonNull LiveRegionModegetLiveRegion()
See also
liveRegion

getPaneTitle

public final @NonNull SemanticsPropertyKey<@NonNull StringgetPaneTitle()
See also
paneTitle

getPassword

public final @NonNull SemanticsPropertyKey<UnitgetPassword()
See also
password

getProgressBarRangeInfo

public final @NonNull SemanticsPropertyKey<@NonNull ProgressBarRangeInfogetProgressBarRangeInfo()

getRole

public final @NonNull SemanticsPropertyKey<@NonNull RolegetRole()

The type of user interface element. Accessibility services might use this to describe the element or do customizations. Most roles can be automatically resolved by the semantics properties of this element. But some elements with subtle differences need an exact role. If an exact role is not listed in Role, this property should not be set and the framework will automatically resolve it.

See also
role

getSelectableGroup

public final @NonNull SemanticsPropertyKey<UnitgetSelectableGroup()
See also
selectableGroup

getSelected

public final @NonNull SemanticsPropertyKey<@NonNull BooleangetSelected()
See also
selected

getStateDescription

public final @NonNull SemanticsPropertyKey<@NonNull StringgetStateDescription()
See also
stateDescription

getTestTag

public final @NonNull SemanticsPropertyKey<@NonNull StringgetTestTag()
See also
testTag

getText

public final @NonNull SemanticsPropertyKey<@NonNull List<@NonNull AnnotatedString>> getText()
See also
text

getTextSelectionRange

public final @NonNull SemanticsPropertyKey<@NonNull TextRangegetTextSelectionRange()

getToggleableState

public final @NonNull SemanticsPropertyKey<@NonNull ToggleableStategetToggleableState()
See also
toggleableState

getTraversalIndex

public final @NonNull SemanticsPropertyKey<@NonNull FloatgetTraversalIndex()
See also
traversalIndex

getVerticalScrollAxisRange

public final @NonNull SemanticsPropertyKey<@NonNull ScrollAxisRangegetVerticalScrollAxisRange()