ViewStructureCompat

class ViewStructureCompat

Helper for accessing features in ViewStructure.

Currently this helper class only has features for content capture usage. Other features for Autofill are not available.

Summary

Public functions
Unit

Set the class name of the view, as per View.getAccessibilityClassName().
Unit

Set the content description of the view, as per View.getContentDescription().
Unit
setDimens(
    left: Int,
    top: Int,
    scrollX: Int,
    scrollY: Int,
    width: Int,
    height: Int
)

Set the basic dimensions of this view.
Unit
setText(charSequence: CharSequence)

Set the text that is associated with this view.
ViewStructure

Provides the ViewStructure represented by this object.
java-static ViewStructureCompat
@RequiresApi(value = 23)
toViewStructureCompat(contentCaptureSession: ViewStructure)

Provides a backward-compatible wrapper for ViewStructure.

Public functions

setClassName

Added in 1.11.0
fun setClassName(string: String): Unit

Set the class name of the view, as per View.getAccessibilityClassName(). Compatibility behavior:

  • SDK 23 and above, this method matches platform behavior.
  • SDK 22 and below, this method does nothing.

setContentDescription

Added in 1.11.0
fun setContentDescription(charSequence: CharSequence): Unit

Set the content description of the view, as per View.getContentDescription(). Compatibility behavior:

  • SDK 23 and above, this method matches platform behavior.
  • SDK 22 and below, this method does nothing.

setDimens

Added in 1.11.0
fun setDimens(
    left: Int,
    top: Int,
    scrollX: Int,
    scrollY: Int,
    width: Int,
    height: Int
): Unit

Set the basic dimensions of this view.

Parameters
left: Int

The view's left position, in pixels relative to its parent's left edge.
top: Int

The view's top position, in pixels relative to its parent's top edge.
scrollX: Int

How much the view's x coordinate space has been scrolled, in pixels.
scrollY: Int

How much the view's y coordinate space has been scrolled, in pixels.
width: Int

The view's visible width, in pixels. This is the width visible on screen, not the total data width of a scrollable view.
height: Int

The view's visible height, in pixels. This is the height visible on screen, not the total data height of a scrollable view. Compatibility behavior:

  • SDK 23 and above, this method matches platform behavior.
  • SDK 22 and below, this method does nothing.

setText

Added in 1.11.0
fun setText(charSequence: CharSequence): Unit

Set the text that is associated with this view. There is no selection associated with the text. The text may have style spans to supply additional display and semantic information. Compatibility behavior:

  • SDK 23 and above, this method matches platform behavior.
  • SDK 22 and below, this method does nothing.

toViewStructure

Added in 1.11.0
@RequiresApi(value = 23)
fun toViewStructure(): ViewStructure

Provides the ViewStructure represented by this object.

This method is not supported on devices running SDK <23 since the platform class will not be available.

Returns
ViewStructure

platform class object
See also
toViewStructureCompat

toViewStructureCompat

Added in 1.11.0
@RequiresApi(value = 23)
java-static fun toViewStructureCompat(contentCaptureSession: ViewStructure): ViewStructureCompat

Provides a backward-compatible wrapper for ViewStructure.

This method is not supported on devices running SDK <23 since the platform class will not be available.

Parameters
contentCaptureSession: ViewStructure

platform class to wrap
Returns
ViewStructureCompat

wrapped class