androidx.wear.protolayout.testing

Kotlin |Java

Classes

`LayoutElementAssertion`	Represents a layout element that can be asserted on.
`LayoutElementAssertionsProvider`	Provides the main entry point into testing by exposing methods to find a layout element.
`LayoutElementMatcher`	Wrapper for element matcher lambdas that allows to build string explaining to the developer what conditions are being tested.

Top-level functions summary

`LayoutElementMatcher`	`containsTag(value: String)` Returns a `LayoutElementMatcher` which checks whether the element's metadata tag contains the given value.
`LayoutElementMatcher`	`hasChild(matcher: LayoutElementMatcher)` Returns a `LayoutElementMatcher` which checks whether the element has a child matching the given matcher.
`LayoutElementMatcher`	`hasClickable(clickable: ModifiersBuilders.Clickable)` Returns a `LayoutElementMatcher` which checks whether the element has the specific `Clickable` attached.
`LayoutElementMatcher`	`hasColor(argb: @ColorInt Int)` Returns a `LayoutElementMatcher` which checks whether the element is drawn with the given color.
`LayoutElementMatcher`	`hasContentDescription(pattern: Regex)` Returns a `LayoutElementMatcher` which checks whether the element's content description matches the given pattern.
`LayoutElementMatcher`	`hasContentDescription(value: String)` Returns a `LayoutElementMatcher` which checks whether the element's content description contains the given value.
`LayoutElementMatcher`	`hasDescendant(matcher: LayoutElementMatcher)` Returns a `LayoutElementMatcher` which checks whether the element has a descendant matches the given matcher.
`LayoutElementMatcher`	`hasHeight(height: DimensionBuilders.ContainerDimension)` Returns a `LayoutElementMatcher` which checks whether the element has the given height value.
`LayoutElementMatcher`	`hasHeight(height: DimensionBuilders.ProportionalDimensionProp)` Returns a `LayoutElementMatcher` which checks whether the element has the given height value.
`LayoutElementMatcher`	`hasImage(protolayoutResId: String)` Returns a `LayoutElementMatcher` which checks whether the element displays an image with the given protolayout resource id.
`LayoutElementMatcher`	`hasText(value: TypeBuilders.StringProp)` Returns a `LayoutElementMatcher` which checks whether the element's text equals the given value.
`LayoutElementMatcher`	`hasText(value: String, subString: Boolean, ignoreCase: Boolean)` Returns a `LayoutElementMatcher` which checks whether the element's text contains the given value.
`LayoutElementMatcher`	`hasWidth(width: DimensionBuilders.ContainerDimension)` Returns a `LayoutElementMatcher` which checks whether the element has the given width value.
`LayoutElementMatcher`	`hasWidth(width: DimensionBuilders.ProportionalDimensionProp)` Returns a `LayoutElementMatcher` which checks whether the element has the given width value.
`LayoutElementMatcher`	`isClickable()` Returns a `LayoutElementMatcher` which checks whether the element is clickable.

Top-level functions

containsTag

Artifact: androidx.wear.protolayout:protolayout-testing

View Source

fun containsTag(value: String): LayoutElementMatcher

Returns a LayoutElementMatcher which checks whether the element's metadata tag contains the given value.

hasChild

Artifact: androidx.wear.protolayout:protolayout-testing

View Source

fun hasChild(matcher: LayoutElementMatcher): LayoutElementMatcher

Returns a LayoutElementMatcher which checks whether the element has a child matching the given matcher.

hasClickable

Artifact: androidx.wear.protolayout:protolayout-testing

View Source

fun hasClickable(clickable: ModifiersBuilders.Clickable): LayoutElementMatcher

Returns a LayoutElementMatcher which checks whether the element has the specific Clickable attached.

hasColor

Artifact: androidx.wear.protolayout:protolayout-testing

View Source

fun hasColor(argb: @ColorInt Int): LayoutElementMatcher

Returns a LayoutElementMatcher which checks whether the element is drawn with the given color.

hasContentDescription

Artifact: androidx.wear.protolayout:protolayout-testing

View Source

fun hasContentDescription(pattern: Regex): LayoutElementMatcher

Returns a LayoutElementMatcher which checks whether the element's content description matches the given pattern.

Parameters
`pattern: Regex`	String pattern to match with content description.

hasContentDescription

Artifact: androidx.wear.protolayout:protolayout-testing

View Source

fun hasContentDescription(value: String): LayoutElementMatcher

Returns a LayoutElementMatcher which checks whether the element's content description contains the given value.

Parameters
`value: String`	Value to match with content description.

hasDescendant

Artifact: androidx.wear.protolayout:protolayout-testing

View Source

fun hasDescendant(matcher: LayoutElementMatcher): LayoutElementMatcher

Returns a LayoutElementMatcher which checks whether the element has a descendant matches the given matcher.

hasHeight

Artifact: androidx.wear.protolayout:protolayout-testing

View Source

fun hasHeight(height: DimensionBuilders.ContainerDimension): LayoutElementMatcher

Returns a LayoutElementMatcher which checks whether the element has the given height value.

hasHeight

Artifact: androidx.wear.protolayout:protolayout-testing

View Source

fun hasHeight(height: DimensionBuilders.ProportionalDimensionProp): LayoutElementMatcher

Returns a LayoutElementMatcher which checks whether the element has the given height value.

hasImage

Artifact: androidx.wear.protolayout:protolayout-testing

View Source

fun hasImage(protolayoutResId: String): LayoutElementMatcher

Returns a LayoutElementMatcher which checks whether the element displays an image with the given protolayout resource id.

Parameters
`protolayoutResId: String`	The resource id of the image, which should be a protolayout resource id instead of android resource id.

hasText

Artifact: androidx.wear.protolayout:protolayout-testing

View Source

fun hasText(value: TypeBuilders.StringProp): LayoutElementMatcher

Returns a LayoutElementMatcher which checks whether the element's text equals the given value.

hasText

Artifact: androidx.wear.protolayout:protolayout-testing

View Source

fun hasText(value: String, subString: Boolean = false, ignoreCase: Boolean = false): LayoutElementMatcher

Returns a LayoutElementMatcher which checks whether the element's text contains the given value.

Note that this only checks the static content of the element's text.

hasWidth

Artifact: androidx.wear.protolayout:protolayout-testing

View Source

fun hasWidth(width: DimensionBuilders.ContainerDimension): LayoutElementMatcher

Returns a LayoutElementMatcher which checks whether the element has the given width value.

hasWidth

Artifact: androidx.wear.protolayout:protolayout-testing

View Source

fun hasWidth(width: DimensionBuilders.ProportionalDimensionProp): LayoutElementMatcher

Returns a LayoutElementMatcher which checks whether the element has the given width value.

isClickable

Artifact: androidx.wear.protolayout:protolayout-testing

View Source

fun isClickable(): LayoutElementMatcher

Returns a LayoutElementMatcher which checks whether the element is clickable.