sdk/ai.abra.sdk.snapshot.abra/AbraElement

AbraElement

@JsonClass(generateAdapter = true)

data class AbraElement(val kind: String = SemanticKind.ABRA, val node: AccessibilityNodeInfoCompat? = null, val depth: Int, val window: AbraWindow?, var parent: AbraElement? = null, val actionsList: List<AccessibilityAction>? = null, val availableExtraNodeData: List<String>? = null, var bounds: Bounds, val canOpenPopup: Boolean, val childCount: Int, var children: List<AbraElement>, @Json(name = "className") val className: String?, val collectionInfo: AccessibilityNodeInfoCompat.CollectionInfoCompat? = null, val collectionItemInfo: AccessibilityNodeInfoCompat.CollectionItemInfoCompat? = null, val collectionIsHierarchical: Boolean, val collectionColumnCount: Int?, val collectionRowCount: Int?, val collectionSelectionMode: Int?, val containerTitle: Sequence?, val contentDescription: Sequence?, val drawingOrder: Int, val error: Sequence?, val extraRenderingInfo: AccessibilityNodeInfo.ExtraRenderingInfo? = null, val extras: Bundle = Bundle(), val hasRequestInitialAccessibilityFocus: Boolean, val hintText: Sequence?, val index: Int, val inputType: InputType, var labeledBy: AbraElementLabel? = null, var labelFor: AbraElement? = null, val layoutHeight: Int?, val layoutHeightUnit: LayoutSize?, val layoutSize: Bounds? = null, val layoutWidth: Int?, val layoutWidthUnit: LayoutSize?, val liveRegion: LiveRegion, val maxTextLength: Int, val minDurationBetweenContentChangesMilli: Long, val movementGranularities: MovementGranularity?, val packageName: String?, val paneTitle: Sequence?, val rangeInfo: RangeInfo?, val resourceName: String?, val roleDescription: Sequence?, val stateDescription: Sequence?, val text: Sequence?, var textCharacterLocations: List<Bounds> = listOf(), val textSelectionEnd: Int, val textSelectionStart: Int, val textSizeInPx: Float?, val textSizeUnit: TextSize?, val tooltipText: Sequence?, val touchDelegateInfo: AccessibilityNodeInfoCompat.TouchDelegateInfoCompat? = null, var traversalAfter: AbraElementTraversal? = null, var traversalBefore: AbraElementTraversal? = null, val uniqueId: String?, val windowId: Int, val isAccessibilityDataSensitive: Boolean, val isAccessibilityFocused: Boolean, @Json(name = "isCheckable") val isCheckable: Boolean, val isChecked: Boolean, val isClickable: Boolean, @Json(name = "isCollection") val isCollection: Boolean, val isCollectionItem: Boolean, val isContentInvalid: Boolean, val isContextClickable: Boolean, val isDismissible: Boolean, val isEditable: Boolean, val isEnabled: Boolean, val isFieldRequired: Boolean, val isFocusable: Boolean, val isFocused: Boolean, val isGranularScrollingSupported: Boolean, @Json(name = "isHeading") val isHeading: Boolean, val isImportantForAccessibility: Boolean, val isLongClickable: Boolean, val isMultiLine: Boolean, val isPassword: Boolean, val isScreenReaderFocusable: Boolean, val isScrollable: Boolean, val isSelected: Boolean, val isShowingHintText: Boolean, val isTextEntryKey: Boolean, val isTextSelectable: Boolean, val isVisibleToUser: Boolean) : SemanticElement<AbraElement>

Constructors

constructor(kind: String = SemanticKind.ABRA, node: AccessibilityNodeInfoCompat? = null, depth: Int, window: AbraWindow?, parent: AbraElement? = null, actionsList: List<AccessibilityAction>? = null, availableExtraNodeData: List<String>? = null, bounds: Bounds, canOpenPopup: Boolean, childCount: Int, children: List<AbraElement>, @Json(name = "className") className: String?, collectionInfo: AccessibilityNodeInfoCompat.CollectionInfoCompat? = null, collectionItemInfo: AccessibilityNodeInfoCompat.CollectionItemInfoCompat? = null, collectionIsHierarchical: Boolean, collectionColumnCount: Int?, collectionRowCount: Int?, collectionSelectionMode: Int?, containerTitle: Sequence?, contentDescription: Sequence?, drawingOrder: Int, error: Sequence?, extraRenderingInfo: AccessibilityNodeInfo.ExtraRenderingInfo? = null, extras: Bundle = Bundle(), hasRequestInitialAccessibilityFocus: Boolean, hintText: Sequence?, index: Int, inputType: InputType, labeledBy: AbraElementLabel? = null, labelFor: AbraElement? = null, layoutHeight: Int?, layoutHeightUnit: LayoutSize?, layoutSize: Bounds? = null, layoutWidth: Int?, layoutWidthUnit: LayoutSize?, liveRegion: LiveRegion, maxTextLength: Int, minDurationBetweenContentChangesMilli: Long, movementGranularities: MovementGranularity?, packageName: String?, paneTitle: Sequence?, rangeInfo: RangeInfo?, resourceName: String?, roleDescription: Sequence?, stateDescription: Sequence?, text: Sequence?, textCharacterLocations: List<Bounds> = listOf(), textSelectionEnd: Int, textSelectionStart: Int, textSizeInPx: Float?, textSizeUnit: TextSize?, tooltipText: Sequence?, touchDelegateInfo: AccessibilityNodeInfoCompat.TouchDelegateInfoCompat? = null, traversalAfter: AbraElementTraversal? = null, traversalBefore: AbraElementTraversal? = null, uniqueId: String?, windowId: Int, isAccessibilityDataSensitive: Boolean, isAccessibilityFocused: Boolean, @Json(name = "isCheckable") isCheckable: Boolean, isChecked: Boolean, isClickable: Boolean, @Json(name = "isCollection") isCollection: Boolean, isCollectionItem: Boolean, isContentInvalid: Boolean, isContextClickable: Boolean, isDismissible: Boolean, isEditable: Boolean, isEnabled: Boolean, isFieldRequired: Boolean, isFocusable: Boolean, isFocused: Boolean, isGranularScrollingSupported: Boolean, @Json(name = "isHeading") isHeading: Boolean, isImportantForAccessibility: Boolean, isLongClickable: Boolean, isMultiLine: Boolean, isPassword: Boolean, isScreenReaderFocusable: Boolean, isScrollable: Boolean, isSelected: Boolean, isShowingHintText: Boolean, isTextEntryKey: Boolean, isTextSelectable: Boolean, isVisibleToUser: Boolean)

constructor(node: AccessibilityNodeInfoCompat, depth: Int, index: Int, window: AbraWindow?, parent: AbraElement?, visited: MutableSet<AccessibilityNodeInfoCompat> = mutableSetOf())

Convenience constructor that initializes from AccessibilityNodeInfoCompat

Types

object Companion

Properties

val actionsList: List<AccessibilityAction>?

val allChildren: List<AbraElement>

val allDescendants: List<AbraElement>

availableExtraNodeData

val availableExtraNodeData: List<String>?

open override var bounds: Bounds

val canOpenPopup: Boolean

open override val childCount: Int

open override var children: List<AbraElement>

open override val className: String?

collectionColumnCount

val collectionColumnCount: Int?

val collectionInfo: AccessibilityNodeInfoCompat.CollectionInfoCompat?

collectionIsHierarchical

val collectionIsHierarchical: Boolean

collectionItemInfo

val collectionItemInfo: AccessibilityNodeInfoCompat.CollectionItemInfoCompat?

collectionRowCount

val collectionRowCount: Int?

collectionSelectionMode

val collectionSelectionMode: Int?

val containerTitle: Sequence?

contentDescription

open override val contentDescription: Sequence?

open override val depth: Int

open override val drawingOrder: Int

val error: Sequence?

extraRenderingInfo

val extraRenderingInfo: AccessibilityNodeInfo.ExtraRenderingInfo?

val extras: Bundle

@Json(name = "hash")

hasRequestInitialAccessibilityFocus

val hasRequestInitialAccessibilityFocus: Boolean

open override val hintText: Sequence?

@Json(name = "id")

open override val index: Int

val inputType: InputType

isAccessibilityDataSensitive

val isAccessibilityDataSensitive: Boolean

isAccessibilityFocused

val isAccessibilityFocused: Boolean

val isCheckable: Boolean

open override val isChecked: Boolean

open override val isClickable: Boolean

val isCollection: Boolean

isCollectionItem

val isCollectionItem: Boolean

isContentInvalid

val isContentInvalid: Boolean

isContextClickable

val isContextClickable: Boolean

val isDismissible: Boolean

open override val isEditable: Boolean

open override val isEnabled: Boolean

isFieldRequired

val isFieldRequired: Boolean

open override val isFocusable: Boolean

val isFocused: Boolean

isGranularScrollingSupported

val isGranularScrollingSupported: Boolean

val isHeading: Boolean

isImportantForAccessibility

open override val isImportantForAccessibility: Boolean

isLongClickable

open override val isLongClickable: Boolean

val isMultiLine: Boolean

val isOnEdge: Boolean

Checks if element is on edge of scroll container

val isPassword: Boolean

isScreenReaderFocusable

open override val isScreenReaderFocusable: Boolean

open override val isScrollable: Boolean

@Json(name = "isSelected")

val isSelected: Boolean

isShowingHintText

val isShowingHintText: Boolean

val isTextEntryKey: Boolean

isTextSelectable

val isTextSelectable: Boolean

isVisibleToUser

open override val isVisibleToUser: Boolean

open override val kind: String

var labeledBy: AbraElementLabel?

var labelFor: AbraElement?

val layoutHeight: Int?

layoutHeightUnit

val layoutHeightUnit: LayoutSize?

val layoutSize: Bounds?

val layoutWidth: Int?

layoutWidthUnit

val layoutWidthUnit: LayoutSize?

val liveRegion: LiveRegion

val maxTextLength: Int

minDurationBetweenContentChangesMilli

val minDurationBetweenContentChangesMilli: Long

movementGranularities

val movementGranularities: MovementGranularity?

val node: AccessibilityNodeInfoCompat?

open override val packageName: String?

val paneTitle: Sequence?

open override var parent: AbraElement?

val parents: List<AbraElement>

val rangeInfo: RangeInfo?

open override val resourceName: String?

roleDescription

open override val roleDescription: Sequence?

roleDescriptionExtra

val roleDescriptionExtra: String?

Retrieves roleDescription from extras

stateDescription

open override val stateDescription: Sequence?

@Json(name = "text")

open override val text: Sequence?

textCharacterLocations

open override var textCharacterLocations: List<Bounds>

textCharacterSize

val textCharacterSize: Bounds

textSelectionEnd

val textSelectionEnd: Int

textSelectionStart

val textSelectionStart: Int

open override val textSizeInPx: Float?

open override val textSizeUnit: TextSize?

val tooltipText: Sequence?

touchDelegateInfo

val touchDelegateInfo: AccessibilityNodeInfoCompat.TouchDelegateInfoCompat?

var traversalAfter: AbraElementTraversal?

traversalBefore

var traversalBefore: AbraElementTraversal?

open override val uniqueId: String?

open override val window: AbraWindow?

open override val windowId: Int

Functions

fun getName(): String?

Retrieves the accessible name of the element. Based on labeledBy, contentDescription, text and children

fun getRole(): Role?

Retrieves the accessible role of the element. Based on className, roleDescription, extras and children

fun getState(): String?

Retrieves the accessible state of the element Based on stateDescription, collectionItemInfo, isSelected, isCheckable and children

fun getValue(): String?

Retrieves the accessible value of the element Based on rangeInfo, text and children

hasNonActionableSpeakingChildren

fun AbraElement.hasNonActionableSpeakingChildren(): Boolean

fun AbraElement.hasState(): Boolean

Based on the Talkback implementation

fun AbraElement.hasText(): Boolean

Based on the Talkback implementation

hasValidRangeInfo

fun AbraElement.hasValidRangeInfo(): Boolean

Based on the Talkback implementation

open override fun height(): Int

Returns the height to be used when scaling

fun AbraElement.isActionable(): Boolean

fun AbraElement.isOverlapped(): Boolean

isSpeakingElement

fun AbraElement.isSpeakingElement(): Boolean

Based on the Talkback implementation

open override fun scale(factor: Double): AbraElement

Scale AbraElement using the given factor. Affects: bounds, textCharacterLocations and children

open fun scale(maxWidth: Int, maxHeight: Int): AbraElement

Scale T to fit within the given maxWidth and maxHeight.

fun AbraElement.supportsAction(action: AccessibilityAction.Type): Boolean

Based on the Talkback implementation

open fun toJSON(): String

Helper method to convert an object to JSON

open override fun toString(): String

open override fun width(): Int

Returns the width to be used when scaling